Canvas Notice Handlers API

openapi: 3.2.0
info:
  title: Canvas LMS REST Notice Handlers API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Notice Handlers
  x-resource: notice_handlers
  externalDocs:
    url: https://canvas.instructure.com/doc/api/notice_handlers.html
paths:
  /lti/notice-handlers/{context_external_tool_id}:
    get:
      tags:
      - Notice Handlers
      operationId: show_notice_handlers
      summary: Show notice handlers
      description: List all notice handlers for the tool
      parameters:
      - name: context_external_tool_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoticeCatalog'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/notice_handlers.html
    put:
      tags:
      - Notice Handlers
      operationId: set_notice_handler
      summary: Set notice handler
      description: Subscribe (set) or unsubscribe (remove) a notice handler for the tool
      parameters:
      - name: context_external_tool_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                notice_type:
                  type: string
                  description: The type of notice
                handler:
                  type: string
                  description: URL to receive the notice, or an empty string to unsubscribe
                max_batch_size:
                  type: integer
                  format: int64
                  description: The maximum number of notices to include in a single batch
              required:
              - notice_type
              - handler
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                notice_type:
                  type: string
                  description: The type of notice
                handler:
                  type: string
                  description: URL to receive the notice, or an empty string to unsubscribe
                max_batch_size:
                  type: integer
                  format: int64
                  description: The maximum number of notices to include in a single batch
              required:
              - notice_type
              - handler
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoticeHandler'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/notice_handlers.html
components:
  schemas:
    NoticeCatalog:
      type: object
      properties:
        client_id:
          type: string
          example: '10000000000001'
          description: The LTI tool's client ID (global developer key ID)
        deployment_id:
          type: string
          example: 123:8865aa05b4b79b64a91a86042e43af5ea8ae79eb
          description: String that identifies the Platform-Tool integration governing the notices
        notice_handlers:
          type: array
          items:
            $ref: '#/components/schemas/NoticeHandler'
          example:
          - handler: ''
            notice_type: LtiHelloWorldNotice
          description: List of notice handlers for the tool
      description: Set of notice handlers (one per notice type) for an LTI tool deployment.
    NoticeHandler:
      type: object
      properties:
        handler:
          type: string
          example: https://example.com/notice_handler
          description: URL to receive the notice
        notice_type:
          type: string
          example: LtiHelloWorldNotice
          description: The type of notice
        max_batch_size:
          type: integer
          example: 100
          description: The maximum number of notices to include in a single batch, or 'null' if not set.
      description: A notice handler for a particular tool deployment and notice type.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Canvas OAuth2 access token sent as "Authorization: Bearer <token>". See https://canvas.instructure.com/doc/api/file.oauth.html'
    oauth2:
      type: oauth2
      description: Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauth_endpoints.html
      flows:
        authorizationCode:
          authorizationUrl: https://canvas.instructure.com/login/oauth2/auth
          tokenUrl: https://canvas.instructure.com/login/oauth2/token
          refreshUrl: https://canvas.instructure.com/login/oauth2/token
          scopes: {}
externalDocs:
  description: Canvas LMS REST API Documentation
  url: https://canvas.instructure.com/doc/api/
x-generated-from: https://canvas.instructure.com/doc/api/api-docs.json
x-provenance:
  method: derived
  derived_by: API Evangelist enrichment pipeline (Swagger 1.2 -> OpenAPI 3.1 conversion)
  source: openapi/_original/swagger-1.2/*.json (144 verbatim first-party Swagger 1.2 documents)
  source_url: https://canvas.instructure.com/doc/api/api-docs.json
  fetched: '2026-09-05'
  http_status: 200