Webhook

In this topic Hide

About this page

A webhook is an API concept that may also be called a "web callback" or when used in conjunction with an API, an "event-driven API".

It provides a method for a web application to provide other applications with real-time information. The RME webhook is designed to send a POST request to the defined URL with details of any subscribed event when they occur, such as an approved application. It saves administrators from having to check for events.

This is currently a proof of concept and currently only supports a few HDR Candidature Management eForm events.

Menu path: RME > Integrations > Webhook (Search) > Webhook

 

Prerequisite

Important! To use this feature successfully, you must have experience with using APIs.

For information about the RME API – Read Only, refer to the APIs for RME document in the package.

 

Search for a webhook

For tips on searching for existing webhooks, see: Search

 

Configure a webhook

1.     In the search page, click New in the toolbar.

2.     Complete the fields, using the table below as a guide.

3.     Select Save.

Webhook: Fields


Field Label

Description

Event *

Mandatory

Event that triggers the sending of data to the subscribed URL

The following options for HDRCM eForms are currently offered:

Event

eForm template category

Field that triggers event

Change of Study Mode Approved

Change of Study Mode

Date is entered in Effective Date

Course Extension Approved

Course Extension

Is Extension Approved? = Yes

Leave Approved

Leave

Is Leave Approved? = Yes

Scholarship Approved

Enrolment and Sch. Application

Is Scholarship Approved? = Yes

 

When the Push to Database Tables workflow activity is executed for an eForm that includes one of the above events, if conditions are met, the event will be triggered.

 

Is Current?

Indicates whether the webhook is enabled (Yes), or disabled (No)

Payload URL *

Mandatory

Where to send data for the event, such as an API URL

Subscribed URLs will receive data that contains the event name and the IDs, such as Primary Keys, that you use to retrieve the created or updated core records using the RME API – Read Only.

The Application ID refers to the eForm Application Primary Key.

Secret

Secret used for API request verification
  
 

Successful Deliveries

This section lists all event deliveries that were successful. To see further details, click the Open icon next to the event in the grid to view the Successful Delivery page.
The following information is provided in the grid:

Column

Description

Status

Indication of the message state, such as Scheduled or Successful

Time Last Attempted

Timestamp of the latest delivery attempt

Number of Attempts

How many times the attempt to send the message was made

Maximum possible number: 3

The data in the grid can be exported into a .csv format file via the Export option on the far top right.

 

Rescheduled Deliveries

This section lists all event deliveries that were rescheduled, indicating the cause of unsuccessful delivery. To see further details, click the Open icon next to the event in the grid to view the Rescheduled Delivery page.
The following information is provided in the grid:

Column

Description

Status

Indication of the message state, such as Rescheduled

Time Last Attempted

Timestamp of the latest delivery attempt

Number of Attempts

How many times the attempt to send the message was made

Maximum possible number: 3

Error Code

Code to indicate the cause of unsuccessful delivery that triggered the Rescheduled status

To re-send one or more deliveries in this grid, select the checkbox to the left of each item, then select Resend Selected Deliveries to the top right of the grid.

The data in the grid can be exported into a .csv format file via the Export option on the far top right.

 

Failed Deliveries

This section lists all event deliveries that failed after the maximum number of attempts. To see further details, click the Open icon next to the event in the grid to view the Failed Delivery page.
The following information is provided in the grid:

Column

Description

Status

Indication of the message state, such as Failed

Time Last Attempted

Timestamp of the latest delivery attempt

Number of Attempts

How many times the attempt to send the message was made

Maximum possible number: 3

Error Code

Code to indicate the cause of unsuccessful delivery

The data in the grid can be exported into a .csv format file via the Export option on the far top right of the grid.

 

Product Key: API - RME API - Ready Only and the related modules or domain (current HDRCM so eForms - [relevant eForm template category]

Page ID: WHK001.htm