36360learning
Subscriptions

Edit a webhook subscription

Changed on

🔑

Required OAuth scope: webhooks:write.

Edits specific fields of an existing webhook subscription. Fields not included in the request payload remain unchanged.

patch/api/v2/webhooks/subscriptions/{subscriptionId}

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/webhooks/subscriptions/{subscriptionId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Path parameters

subscriptionIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the webhook subscription.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

namestring

The name of the webhook subscription.

status'active' | 'inactive'

The status of the webhook subscription. Options are:

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

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 updated webhook subscription.

eventType'bulk.operation.created' | 'bulk.operation.ended' | 'classroom.slot.attendance.sheet.signed' | 'course.attempt.closed' | 'courses.skills.added' | 'courses.skills.removed' | 'group.created' | 'group.deleted' | 'group.updated' | 'groups.catalog.courses.added' | 'groups.catalog.path.sessions.added' | 'groups.library.courses.added' | 'groups.library.courses.removed' | 'groups.library.paths.added' | 'groups.library.paths.removed' | 'path.archived' | 'path.created' | 'path.deleted' | 'path.session.added' | 'path.session.removed' | 'path.session.classroom.slot.created' | 'path.session.classroom.slot.deleted' | 'path.session.classroom.slot.updated' | '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' | 'paths.skills.added' | 'paths.skills.removed' | 'path.updated' | 'skill.created' | 'skill.deleted' | 'skill.updated' | 'user.activated' | 'user.assessment.corrected' | 'user.certificate.awarded' | 'user.classroom.slot.registered' | 'user.classroom.slot.rsvp.going.yes' | 'user.classroom.slot.rsvp.going.no' | 'user.classroom.slot.unregistered' | 'user.created' | 'user.customfield.created' | 'user.customfield.deleted' | 'user.customfield.updated' | 'user.customfield.values.updated' | '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"
}

Changes

  • c2110549e263Revision changes
    • breaking

      added subschema #3: Url Scheme to the response body oneOf list for the response status

    • warning

      added the new classroom.slot.attendance.sheet.signed enum value to the response property for the response status

    • warning

      added the new courses.skills.added enum value to the response property for the response status

    • warning

      added the new courses.skills.removed enum value to the response property for the response status

    • warning

      added the new groups.catalog.courses.added enum value to the response property for the response status

    • warning

      added the new groups.catalog.path.sessions.added enum value to the response property for the response status

    • warning

      added the new groups.library.courses.added enum value to the response property for the response status

    • warning

      added the new groups.library.courses.removed enum value to the response property for the response status

    • warning

      added the new groups.library.paths.added enum value to the response property for the response status

    • warning

      added the new groups.library.paths.removed enum value to the response property for the response status

    • warning

      added the new path.session.classroom.slot.created enum value to the response property for the response status

    • warning

      added the new path.session.classroom.slot.deleted enum value to the response property for the response status

    • warning

      added the new path.session.classroom.slot.updated enum value to the response property for the response status

    • warning

      added the new path.updated enum value to the response property for the response status

    • warning

      added the new paths.skills.added enum value to the response property for the response status

    • warning

      added the new paths.skills.removed enum value to the response property for the response status

    • warning

      added the new skill.created enum value to the response property for the response status

    • warning

      added the new skill.deleted enum value to the response property for the response status

    • warning

      added the new skill.updated enum value to the response property for the response status

    • warning

      added the new user.certificate.awarded enum value to the response property for the response status

    • warning

      added the new user.classroom.slot.registered enum value to the response property for the response status

    • warning

      added the new user.classroom.slot.rsvp.going.no enum value to the response property for the response status

    • warning

      added the new user.classroom.slot.rsvp.going.yes enum value to the response property for the response status

    • warning

      added the new user.classroom.slot.unregistered enum value to the response property for the response status

    • warning

      added the new user.customfield.created enum value to the response property for the response status

    • warning

      added the new user.customfield.deleted enum value to the response property for the response status

    • warning

      added the new user.customfield.updated enum value to the response property for the response status

    • warning

      added the new user.customfield.values.updated enum value to the response property for the response status