Sign in

v1

latestOpenAPI 3.1.02026-07-141045121.7 KB
Subscriptions

Create a webhook subscription

🔑

Required OAuth scope: webhooks:write.

Creates a webhook subscription.

post/api/v2/webhooks/subscriptions

Headers

360-api-version'v2.0' required

The version of the API.

Request body

eventType'bulk.operation.created' | 'bulk.operation.ended' | 'course.attempt.closed' | 'group.created' | 'group.deleted' | 'group.updated' | 'path.archived' | 'path.created' | 'path.deleted' | 'path.session.added' | 'path.session.removed' | 'path.session.classroom.slot.users.unregistered.full' | 'path.session.classroom.slot.waitlist.closed' | 'path.session.classroom.slot.waitlist.opened' | 'path.session.classroom.slot.waitlist.user.joined' | 'path.session.user.status.updated' | 'path.session.users.enrolled' | 'path.session.users.unenrolled' | 'user.activated' | 'user.assessment.corrected' | 'user.created' | 'user.deleted' | 'user.invited' | 'user.reactivated' | 'user.updated' | 'xapi.started' | 'xapi' required

The type of event that should be managed by this webhook subscription.

namestring required

The name of the webhook subscription.

urlstring required

The URL where the events are sent for this webhook subscription.

Example request

{
  "name": "HRIS system subscription",
  "url": "https://example.com/webhook"
}

Response

Returns the created webhook subscription.

eventType'bulk.operation.created' | 'bulk.operation.ended' | 'course.attempt.closed' | 'group.created' | 'group.deleted' | 'group.updated' | 'path.archived' | 'path.created' | 'path.deleted' | 'path.session.added' | 'path.session.removed' | 'path.session.classroom.slot.users.unregistered.full' | 'path.session.classroom.slot.waitlist.closed' | 'path.session.classroom.slot.waitlist.opened' | 'path.session.classroom.slot.waitlist.user.joined' | 'path.session.user.status.updated' | 'path.session.users.enrolled' | 'path.session.users.unenrolled' | 'user.activated' | 'user.assessment.corrected' | 'user.created' | 'user.deleted' | 'user.invited' | 'user.reactivated' | 'user.updated' | 'xapi.started' | 'xapi' required

The type of event that should be managed by this webhook subscription.

namestring required

The name of the webhook subscription.

urlstring required

The URL where the events are sent for this webhook subscription.

_idstring ObjectId required

The unique ID of the webhook subscription.

status'active' | 'inactive' required

The status of the webhook subscription. Options are:

  • active: events are sent to your endpoint.
  • inactive: events are not sent to your endpoint.

Example response

{
  "name": "HRIS system subscription",
  "url": "https://example.com/webhook",
  "_id": "507f1f77bcf86cd799439011"
}