Webhooks - Corsair

The Canvas plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see Overview for setup context and the exact URL shape).

New to Corsair? See webhooks and hooks.

Webhook map

triggers
- assignmentGraded (triggers.assignmentGraded)
- newAssignmentSubmission (triggers.newAssignmentSubmission)
- newCourseCreated (triggers.newCourseCreated)
- newDiscussionMessage (triggers.newDiscussionMessage)
- newDiscussionTopic (triggers.newDiscussionTopic)
- newFileUploaded (triggers.newFileUploaded)

HTTP handler setup

app/api/webhook/route.ts

import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    const body = await request.json();
    const result = await processWebhook(corsair, headers, body);
    return result.response;
}

Events

Triggers

Assignment Graded

triggers.assignmentGraded Canvas Live Event when an assignment grade changes Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            assignmentGraded: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

New Assignment Submission

triggers.newAssignmentSubmission Canvas Live Event when a new assignment submission is created Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            newAssignmentSubmission: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

New Course Created

triggers.newCourseCreated Canvas Live Event when a course is created Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            newCourseCreated: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

New Discussion Message

triggers.newDiscussionMessage Canvas Live Event when a discussion entry is created Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            newDiscussionMessage: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

New Discussion Topic

triggers.newDiscussionTopic Canvas Live Event when a discussion topic is created Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            newDiscussionTopic: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

New File Uploaded

triggers.newFileUploaded Canvas Live Event when a file attachment is created Payload

Name	Type	Required	Description
`type`	`string`	No	—
`created_at`	`string`	No	—
`data`	`object`	No	—
`metadata`	`object`	No	—
`body`	`object`	No	—

data full type

{
}

metadata full type

{
}

body full type

{
}

Response data full type

{
  type?: string,
  created_at?: string,
  data?: {
  },
  metadata?: {
  },
  body?: {
  }
}

webhookHooks example

canvas({
    webhookHooks: {
        triggers: {
            newFileUploaded: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})

​Webhook map

​HTTP handler setup

​Events

​Triggers

​Assignment Graded

​New Assignment Submission

​New Course Created

​New Discussion Message

​New Discussion Topic

​New File Uploaded

Webhook map

HTTP handler setup

Events

Triggers

Assignment Graded

New Assignment Submission

New Course Created

New Discussion Message

New Discussion Topic

New File Uploaded