Everbridge Comms Schedule APIs API

openapi: 3.2.0
info:
  title: Communications Comms Schedule APIs API
  description: Unified Communications APIs
  version: '1.0'
servers:
- url: https://api.everbridge.net/managerapps/communications/v1
tags:
- name: Comms Schedule APIs
paths:
  /schedules:
    get:
      tags:
      - Comms Schedule APIs
      operationId: getSchedules
      summary: List Schedules
      description: List available Comms Schedules.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filters by the name of the schedules. Returns any schedules that contains any word provided in `name` by default.
      - in: query
        name: status
        schema:
          type: string
          enum:
          - Scheduled
          - Paused
          - Ended
        description: Filter the record set by the  status of the schedule. If `status` is not provided, then the record set will include all records.
      - in: query
        name: type
        schema:
          type: string
          enum:
          - OneTime
          - FixedInterval
          - Recurring
        description: Filter the record set by the type of the schedule. Valid values are `OneTime`, `FixedInterval`, and `Recurring`. If `type` is not provided, all schedule types will be included.
      - in: query
        name: createdBy
        schema:
          type: string
        description: Filter by an ID of a user that can create schedules.
      - in: query
        name: fromDate
        schema:
          type: string
          format: date-time
        description: from date as an ISO 8601-compliant value to filter the record by startTime.
      - in: query
        name: toDate
        schema:
          type: string
          format: date-time
        description: to date as an ISO 8601-compliant value to filter the record by startTime.
      - in: query
        name: sortBy
        schema:
          type: string
          enum:
          - startTime
          - created
        description: 'The field to sort the result set by. See `sortDirection` for adjusting the order in which the result set is sorted.

          Defaults to `created`.'
      - in: query
        name: sortDirection
        schema:
          type: string
          enum:
          - ASC
          - ASCENDING
          - DESC
          - DESCENDING
        description: 'The order by which to sort the result set by. `ASC` and `ASCENDING` have the same effect of ordering the values in ascending order; additionally, `DESC` and `DESCENDING` also have the same effect of ordering the values in descending order. See `sortBy` for details on changing which field is used in sorting.

          Defaults to `DESCENDING`.'
      - in: query
        name: pageSize
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
        description: The size of each page of search results. Defaults to ten records.
      - in: query
        name: pageNumber
        schema:
          type: integer
          format: int32
          minimum: 1
        description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 1.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommSchedulePaginatedResponse'
              example:
                data:
                - id: b7e2a1c4-3f8e-4b2a-9c1d-2e6f7a8b9d10
                  status: Scheduled
                  name: Morning Alert
                  description: Send a one-time alert at 9am
                  nextFiredTime: '2026-07-01T09:00:00Z'
                  scheduleConfig:
                    type: OneTime
                    startTime: '2026-07-01T09:00:00Z'
                  commsPayload:
                    title: Earthquake - FORECAST Galesburg, Michigan
                    mode: Live
                    tags:
                    - alert
                    - earthquake
                    publicSafety: false
                    name: EarthquakeAlert
                    priority: NORMAL
                    eventType: Earthquake
                    templateId: commsTemplate://1234abcd
                  created: '2026-06-01T10:00:00Z'
                  createdBy: user-123
                  createdByName: Alice
                  updated: '2026-06-01T10:00:00Z'
                  updatedBy: user-123
                  updatedByName: Alice
                pageSize: 10
                pageNumber: 1
                totalPages: 1
                totalItems: 1
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: GET
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    head:
      tags:
      - Comms Schedule APIs
      operationId: checkSchedulesExist
      summary: Check if schedules exist
      description: Check if any Comms Schedules exist matching the given filters.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filters by the name of the schedules.
      - in: query
        name: status
        schema:
          type: string
          enum:
          - Scheduled
          - Paused
          - Ended
        description: Filter by the status of the schedule.
      - in: query
        name: type
        schema:
          type: string
          enum:
          - OneTime
          - FixedInterval
          - Recurring
        description: Filter the record set by the type of the schedule. Valid values are `OneTime`, `FixedInterval`, and `Recurring`. If `type` is not provided, all schedule types will be included.
      - in: query
        name: createdBy
        schema:
          type: string
        description: Filter by an ID of a user that can create schedules.
      - in: query
        name: fromDate
        schema:
          type: string
          format: date-time
        description: Start date as an ISO 8601-compliant value to filter the record startTime.
      - in: query
        name: toDate
        schema:
          type: string
          format: date-time
        description: End date as an ISO 8601-compliant value to filter the record startTime.
      responses:
        '200':
          description: At least one schedule matches the filters.
        '404':
          description: No schedules match the filters.
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: HEAD
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    post:
      tags:
      - Comms Schedule APIs
      operationId: createSchedule
      summary: Create Schedule
      description: Create a new Comms Schedule.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduleRequest'
            examples:
              Creating a OneTime Schedule:
                summary: Create a Morning Alert tiggered at 2026-07-01 9am
                value:
                  name: Morning Alert
                  description: Send a one-time alert at 9am
                  scheduleConfig:
                    type: OneTime
                    startTime: '2026-07-01T09:00:00Z'
                  commsPayload:
                    title: System update reminder
                    mode: Live
                    priority: Normal
                    eventType: General
                    launchedFrom: API
                    message:
                      contents:
                      - type: Textual
                        contentType: text/plain
                        title: System update reminder
                        content: System update reminder.
                        paths:
                        - CATEGORY:EMAIL
                    settings:
                      sender:
                        email:
                          name: Mitten Circus Attractions Inc.
                          replyToEmail: call4clowns@example.com
                      delivery:
                        paths:
                        - type: Prompt
                          prompt: Email
                        ttl: PT1H
                      recipientInteraction:
                        confirm: false
              Creating a FixedInterval Schedule:
                summary: Create a FixedInterval reminder tiggered at 2025-06-01 8am, ends at 2025-06-01 1pm, and runs every hour for 5 times
                value:
                  name: Hourly Reminder
                  description: Send a reminder every hour for 5 times
                  scheduleConfig:
                    type: FixedInterval
                    startTime: '2025-06-01T08:00:00Z'
                    endTime: '2025-06-01T13:00:00Z'
                    maxCount: 5
                    timeInterval: PT1H
                  commsPayload:
                    title: morning alert
                    mode: Live
                    priority: Normal
                    eventType: General
                    launchedFrom: API
                    message:
                      contents:
                      - type: Textual
                        contentType: text/plain
                        title: morning alert
                        content: morning alert.
                        paths:
                        - CATEGORY:SMS
                    settings:
                      sender:
                        email:
                          name: Mitten Circus Attractions Inc.
                          replyToEmail: call4clowns@example.com
                      delivery:
                        paths:
                        - type: Prompt
                          prompt: Email
                        ttl: PT1H
                      recipientInteraction:
                        confirm: false
              Creating a Recurring Schedule:
                summary: Create a Recurring Schedule tirgered at 12-31 12pm every year in Vancouver
                value:
                  name: Year End Notification
                  description: Send a notification every year on December 31st at noon
                  scheduleConfig:
                    type: Recurring
                    startTime: '2025-12-31T12:00:00Z'
                    frequency:
                      type: Yearly
                      month: 12
                      day_of_month: 31
                      time: '12:00:00'
                      timeZoneId: America/Vancouver
                  commsPayload:
                    title: System update reminder
                    mode: Live
                    priority: Normal
                    eventType: General
                    launchedFrom: API
                    message:
                      contents:
                      - type: Textual
                        contentType: text/plain
                        title: System update reminder
                        content: System update reminder.
                        paths:
                        - CATEGORY:EMAIL
                    settings:
                      sender:
                        email:
                          name: Mitten Circus Attractions Inc.
                          replyToEmail: call4clowns@example.com
                      delivery:
                        paths:
                        - type: Prompt
                          prompt: Email
                        ttl: PT1H
                      recipientInteraction:
                        confirm: false
      responses:
        '201':
          description: The schedule was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAndUpdateScheduleResponse'
              examples:
                Successful creation of a schedule:
                  summary: Schedule created
                  value:
                    id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        '400':
          description: The request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
        '401':
          description: The token provided does not have permission to create a new schedule.
        '500':
          description: An internal error has occurred. This may not always return a response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: POST
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules
        responses:
          default:
            statusCode: '201'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
  /schedules/{id}:
    get:
      tags:
      - Comms Schedule APIs
      operationId: getScheduleById
      summary: Get schedule by ID
      description: Retrieve a Comms Schedule by its unique identifier.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique ID of the schedule.
      - in: query
        name: includeCommsDetails
        required: false
        schema:
          type: boolean
          default: true
        description: If true, the response will include the full details of the commsPayload. If false, the commsPayload field will be omitted from the response.
      responses:
        '200':
          description: Schedule found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommScheduleResponse'
              example:
                Return a OneTime Schedule.:
                  summary: Return a OneTime Schedule
                  value:
                    id: b7e2a1c4-3f8e-4b2a-9c1d-2e6f7a8b9d10
                    status: Scheduled
                    name: Morning Alert
                    description: Send a one-time alert at 9am
                    nextFiredTime: '2026-07-01T09:00:00Z'
                    scheduleConfig:
                      type: OneTime
                      startTime: '2026-07-01T09:00:00Z'
                    commsPayload:
                      title: Earthquake - FORECAST Galesburg, Michigan
                      mode: Live
                      priority: Normal
                      eventType: Earthquake
                      launchedFrom: API
                      message:
                        contents:
                        - type: Textual
                          contentType: text/plain
                          title: Earthquake in Galesburg, Michigan
                          content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication.
                          paths:
                          - CATEGORY:EMAIL
                      recipients:
                        groups:
                        - type: Id
                          id: '873461568734615'
                        - type: Name
                          name: MVPs
                    created: '2026-06-01T10:00:00Z'
                    createdBy: user-123
                    createdByName: Alice
                    updated: '2026-06-01T10:00:00Z'
                    updatedBy: user-123
                    updatedByName: Alice
                Return a FixedInterval Schedule.:
                  summary: Return a FixedInterval Schedule
                  value:
                    id: c8f3b2d5-4e9f-4c3a-8d2e-3f7e8b9c0d11
                    status: Scheduled
                    name: Hourly Reminder
                    description: Send a reminder every hour for 5 times
                    nextFiredTime: '2025-06-01T09:00:00Z'
                    scheduleConfig:
                      type: FixedInterval
                      startTime: '2025-06-01T08:00:00Z'
                      endTime: '2025-06-01T13:00:00Z'
                      maxCount: 5
                      timeInterval: PT1H
                    commsPayload:
                      title: System update reminder
                      mode: Live
                      priority: Normal
                      eventType: General
                      launchedFrom: API
                      message:
                        contents:
                        - type: Textual
                          contentType: text/plain
                          title: System update reminder
                          content: System update reminder.
                          paths:
                          - CATEGORY:EMAIL
                      recipients:
                        groups:
                        - type: Id
                          id: '873461568734615'
                        - type: Name
                          name: MVPs
                    created: '2025-05-01T10:00:00Z'
                    createdBy: user-456
                    createdByName: Bob
                    updated: '2025-05-01T10:00:00Z'
                    updatedBy: user-456
                    updatedByName: Bob
                Return a Recurring Schedule.:
                  summary: Return a Recurring Schedule
                  value:
                    id: d9f4c3e6-5f1a-4b7c-9e2f-4a8b9c1d2e13
                    status: Scheduled
                    name: Year End Notification
                    description: Send a notification every year on December 31st at noon
                    nextFiredTime: '2025-12-31T12:00:00Z'
                    scheduleConfig:
                      type: Recurring
                      startTime: '2025-12-31T12:00:00Z'
                      frequency:
                        type: Yearly
                        month: 12
                        day_of_month: 31
                        time: '12:00:00'
                        timeZoneId: America/Vancouver
                    commsPayload:
                      title: Year End System Notification
                      mode: Active
                      priority: Normal
                      eventType: General
                      launchedFrom: API
                      message:
                        contents:
                        - type: Textual
                          contentType: text/plain
                          title: Year End Notification
                          content: This is your annual year-end notification.
                          paths:
                          - CATEGORY:EMAIL
                      recipients:
                        groups:
                        - type: Id
                          id: '873461568734615'
                        - type: Name
                          name: MVPs
                    created: '2025-06-01T10:00:00Z'
                    createdBy: user-789
                    createdByName: Carol
                    updated: '2025-06-01T10:00:00Z'
                    updatedBy: user-789
                    updatedByName: Carol
        '400':
          description: 'Invalid value for: header Authorization, Invalid value for: parameters'
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: No schedule with the given ID exists.
          content:
            text/plain:
              schema:
                type: string
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: GET
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/{id}
        responses:
          default:
            statusCode: '200'
        requestParameters:
          integration.request.path.id: method.request.path.id
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    patch:
      tags:
      - Comms Schedule APIs
      operationId: partial Update ScheduleById
      summary: Update schedule by ID (partial)
      description: Partially update a Comms Schedule by its unique identifier.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique ID of the schedule.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialUpdateScheduleRequest'
            examples:
              Updating the status of the Schedule.:
                summary: Updating the status of the Schedule.
                value:
                  status: Paused
              Updating the comms Payload of the Schedule.:
                summary: Updating the comms launch Payload of the Schedule.
                value:
                  commsPayload:
                    title: Earthquake - FORECAST Galesburg, Michigan
                    mode: Live
                    priority: Normal
                    eventType: Earthquake
                    launchedFrom: API
                    message:
                      contents:
                      - type: Textual
                        contentType: text/plain
                        title: Earthquake in Galesburg, Michigan
                        content: An earthquake was reported in Galesburg, Michigan. Assess the situation and await further communication.
                        paths:
                        - CATEGORY:EMAIL
                    recipients:
                      groups:
                      - type: Id
                        id: '873461568734615'
                      - type: Name
                        name: MVPs
                    templateId: commsTemplate://1234abcd
              Updating the name and description of the Schedule..:
                summary: Updating the name and description of the Schedule.
                value:
                  name: Hourly Reminder
                  description: Send a reminder every hour for 5 times
              Updating the scheduleConfig of a schedule.:
                summary: Updating the recurring of a schedule.
                value:
                  sceduleConfig:
                    type: Recurring
                    startTime: '2025-12-31T12:00:00Z'
                    frequency:
                      type: Yearly
                      month: 12
                      day_of_month: 31
                      time: '12:00:00'
                      timeZoneId: America/Vancouver
        required: true
      responses:
        '200':
          description: Schedule updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAndUpdateScheduleResponse'
              examples:
                Successful update of a schedule:
                  summary: Schedule updated
                  value:
                    id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        '400':
          description: The request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
        '404':
          description: No schedule with the given ID exists.
          content:
            text/plain:
              schema:
                type: string
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: PATCH
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/{id}
        responses:
          default:
            statusCode: '200'
        requestParameters:
          integration.request.path.id: method.request.path.id
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
    delete:
      tags:
      - Comms Schedule APIs
      operationId: Delete ScheduleById
      summary: Delete by ID
      description: Delete a Comms Schedule by its unique identifier.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique ID of the schedule.
      responses:
        '200':
          description: Schedule delete successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAndUpdateScheduleResponse'
              examples:
                Successful delete of a schedule:
                  summary: Schedule deleted
                  value:
                    id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        '400':
          description: The request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
        '404':
          description: No schedule with the given ID exists.
          content:
            text/plain:
              schema:
                type: string
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: DELETE
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/{id}
        responses:
          default:
            statusCode: '200'
        requestParameters:
          integration.request.path.id: method.request.path.id
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
  /schedules/{id}/trigger:
    post:
      tags:
      - Comms Schedule APIs
      operationId: triggerSchedule
      summary: Trigger schedule by ID
      description: Manually trigger a schedule by its unique identifier.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique ID of the schedule.
      responses:
        '200':
          description: Schedule triggered successfully.
        '404':
          description: No schedule with the given ID exists.
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: POST
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/{id}/trigger
        responses:
          default:
            statusCode: '200'
        requestParameters:
          integration.request.path.id: method.request.path.id
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
  /schedules/{id}/runs:
    get:
      tags:
      - Comms Schedule APIs
      operationId: getScheduleRunsById
      summary: List schedule runs  by ID
      description: List Schedule runs by its unique identifier and query parameter.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique ID of the schedule.
      - in: query
        name: status
        schema:
          type: string
          enum:
          - Success
          - Failed
        description: Filter the record set by the  status of the schedule. If `status` is not provided, then the record set will include all records.
      - in: query
        name: pageSize
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
        description: The size of each page of search results. Defaults to ten records.
      - in: query
        name: pageNumber
        schema:
          type: integer
          format: int32
          minimum: 1
        description: The requested page number out of the total number of pages. Defaults to the first page, which is page number 1.
      responses:
        '200':
          description: Schedule found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommScheduleJobLogPaginatedResponse'
        '400':
          description: 'Invalid value for: header Authorization, Invalid value for: parameters'
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: No schedule with the given ID exists.
          content:
            text/plain:
              schema:
                type: string
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: GET
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/{id}/runs
        responses:
          default:
            statusCode: '200'
        requestParameters:
          integration.request.path.id: method.request.path.id
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
  /schedules/schedule-config/validate:
    post:
      tags:
      - Comms Schedule APIs
      operationId: validateScheduleConfig
      summary: Validate schedule configuration
      description: Validate a schedule configuration before creating a schedule.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommScheduleConfig'
      responses:
        '200':
          description: Validation result generated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommsValidateResponse'
              example:
                valid: false
                errors:
                - The startTime must be some time in the future.
                errorDetails:
                - field: startTime
                  message: The startTime must be some time in the future.
                  i18nKey: comms.schedule.invalid.future
        '500':
          description: An internal error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetail'
      security:
      - API_Authorizer: []
      x-amazon-apigateway-integration:
        type: http_proxy
        connectionId: 11ofco
        httpMethod: POST
        uri: https://prod-us-us-east-1-0-os-nginx.ue1-0.prod-us.prod.us-east-1.evbg.io/cem-comms/schedules/schedule-config/validate
        responses:
          default:
            statusCode: '200'
        passthroughBehavior: when_no_match
        connectionType: VPC_LINK
components:
  schemas:
    AudioBulletinBoardPublicMessage:
      type: object
      des

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/everbridge/refs/heads/main/openapi/everbridge-comms-schedule-apis-api-openapi.yml