Modern Campus Catalog Emblem Modern Campus CMS Emblem Modern Campus Curriculum Emblem Modern Campus Involve Emblem Modern Campus Lifelong Learning Extended Education Emblem Modern Campus Message Emblem Modern Campus Navigate Emblem Modern Campus Schedule Emblem Modern Campus Virtual Tours & Maps Emblem Modern Campus Lifelong Learning Workfore and Community Emblem Site Menu Open Site Menu Close

Webhooks

You can set a webhook based on actions in Modern Campus CMS, including Modern Campus CMS calendar actions. When the action occurs, Modern Campus CMS sends a message to the URL that you set up to receive incoming HTTP requests. The request is HTTP POST containing JSON data about the action.

Format of Webhooks MessageLink to this section

When enabled in account settings and allowed for site(s), file(s), or folder(s), Modern Campus CMS sends webhook messages using a uuid (set in the JSON object associated with the CMS action).

Actions trigger webhooks, whether completed successfully or if the action causes an error. Modern Campus CMS webhook messages use the following formats:

JSON nameData TypeDescription
accountstringModern Campus CMS account where the action was initiated
sitestringModern Campus CMS site where the action was initiated
userstringModern Campus CMS user who initiated the action
typestring

Type of action initiated.

Possible values:

Modern Campus CMS

  • Page, multi-page, or file publish
  • Folder or multi-directory publish
  • Template publish
  • Rename or move publish
  • Asset or multi-asset publish*
  • Site publish
  • Reports publish
    • Out-of-sync republish
    • Scheduled page or asset publish
    • Scheduled page recycle

  • File or folder recycle
  • File or folder delete

* For asset publish to trigger a webhook, webhooks must be turned on in site access settings.

Modern Campus CMS Calendar

  • Calendar Update
  • Calendar Delete
  • Calendar Sync (External)

  • Event Publish/Republish
  • Event Update
  • Event Recurrence Update
  • Event Delete

  • Location Update
  • Location Delete

  • Organizer Update
  • Organizer Delete
successarray of site/calendar objects

Each successful type of action will be listed here.

The success object is split up by Modern Campus CMS site and/or calendar module.

Each Site object will contain an array of Page objects with the root relative staging path and live URL for each published item.

Each calendar module contains one or more calendars (categories).

failedarray of site/calendar objects

Each failed type of action will be listed here.

The failed object is split up by Modern Campus CMS site and/or calendar module.

Each Site object will contain an array of Page objects with the root relative staging path and reason for failure.

Each calendar module contains one or more calendars (categories).

errorsarray of site/calendar objects

Each error encountered during the type of action will be listed here. The error object is split up by Modern Campus CMS site and/or calendar module.

Each Site object will contain an array of strings detailing the reason(s) for the error.

Each calendar module contains one or more calendars (categories).

success_countnumberCount of the number of successful actions.
failed_countnumberCount of the number of failed actions.
uuidstringUnique identifier for this type of action. The uuid will match on the notification webhook message and the final status webhook message.
beganstringDate and time the action began, according to the staging server.
completedstringDate and time the action completed, according to the staging server.
originarray of strings

File(s) specifically chosen by the user which initiated the publish action. 

For example, if an asset was published, that asset's name would appear here and all of the pages which republished as a result would appear in the success object under its corresponding site.

total_timenumberTime duration for publish action to complete. Measured in seconds.
msgstringDescription of whether the publish action is beginning, ending, or has failed.
eventsstring

Lists the IDs of Modern Campus CMS Calendar events that were affected by this action.

If only one event was affected, extended information is provided for this event.

category_idnumberUnique ID of a calendar [category] that was modified.
category_namestringName of a calendar [category] that was modified.
location_idnumber

Unique ID of a location attribute in Modern Campus CMS Calendar that was modified

location_namestring

Name of a location attribute in Modern Campus CMS Calendar that was modified.

organizer_idnumber

Unique ID of an organizer attribute in Modern Campus CMS Calendar that was modified

organizer_namestring

Name of an organizer attribute in Modern Campus CMS Calendar that was modified.

Listening URL ScriptLink to this section

The script you place at the webhooks URL can be configured to take any actions you see fit based upon the data provided by the webhook message. The exact language and server-side code required at the webhooks URL is dependent upon the language your server is running as well as the resulting actions you'd like to occur.

For example, you could configure your script to create a reporting view for individuals who are not Modern Campus CMS users (zip file with example PHP script). Or you could hit an Modern Campus CMS API Documentation as a reaction to the publication of specific sections or pages (for example causing your faculty listing page to republish whenever a profile page in that section is published).

By continuing to use this site, you agree to the storing of first- and third-party cookies on your device to enhance site navigation; analyze site, product, and service usage; and assist in our marketing and promotional efforts. Cookie Policy