Logo
  • Other versions
  • Virage Group
  • Espace Magenta
  • Support ticket
  • Strat Monitor documentation
Logo

Produced by Virage Group

Project Monitor v7.7 Knowledge Center
Project Monitor v7.7 Knowledge Center
/Administration
Administration
/
Advanced settings
/Webhook
Webhook
Webhook

Webhook

‣
Table of contents
  • List of webhooks
  • Creating and modifying a webhook
  • Non-exhaustive list of error/information messages
icon

Webhook A webhook is a way of notifying a third-party application when an event defined in Project MonitorProject Monitor occurs. For example: you can trigger the creation of a SharePoint space when a new project is created in Project MonitorProject Monitor. See WebhookWebhook Webhooks memoWebhooks memo

🖇️

Read more : Webhooks memoWebhooks memo

List of webhooks

Screen listing the platform's webhooks
Screen listing the platform's webhooks

FilterFilter

image

We can have a filter All projects or a filter that works with criteria.

This button makes it easy to find the items you're looking for. You can use an already saved filter (private or public) or specify specific filter criteria.

🚩
Once selected, a filter remains active until deselected by the user. When logged out, if a filter was active at logout, it will still be active the next time the user logs in.
‣
It is possible to filter this list of webhooks with a filter criterion :
  • ContainsContains

Click on RegisterRegister to apply the filter and CloseClose to return to the list.

🚦

Rights required : View WebhooksView Webhooks

Add

Allows you to add a webhook. Webhook - Creating and modifying a webhookWebhook - Creating and modifying a webhook

🚦

Rights required :

  • View WebhooksView Webhooks
  • Create a WebhookCreate a Webhook

EditEdit

Allows you to modify a webhook. Webhook - Creating and modifying a webhookWebhook - Creating and modifying a webhook

🚦

Rights required :

  • View WebhooksView Webhooks
  • Modifying a WebhookModifying a Webhook

Creating and modifying a webhook

This screen lets you add a webhook to a platform Project MonitorProject Monitor and modify it.

Webhook creation screen
Webhook creation screen
🚦

Rights required :

  • View WebhooksView Webhooks
  • Create a WebhookCreate a Webhook
  • Modifying a WebhookModifying a Webhook
‣
WordingWording

This field allows you to specify the name of the webhook.

‣
DescriptionDescription

This field is used to describe the webhook.

‣
AssetsAssets

This field allows you to enable the webhook by checking the box and disable it by unchecking the box.

‣
URLURL

This field allows you to enter a URL to be accessed via HTTP or HTTPS

‣
VerbVerb

This is the method expected by the third-party application (GET, POST, PUT, PATCH, DEL)

‣
BodyBody

This parameter must be provided for POST, PUT, or PATCH requests

‣
HeadersHeaders

This field is used to enter parameters, such as those required for authentication.

‣
SynchronousSynchronous

One of the following two call modes: o Synchronous:action in PM that triggers the event is completed once the notification to the third-party app is finished. If an error occurs while calling the third-party app, the status code is displayed on the screen. 🚨In this mode, the performance of Project MonitorProject Monitor are affected by the execution time of the third-party application's web service. ▪ Synchronous operation performed within the transaction: The error preventsaction Project MonitorProject Monitor. ▪ Synchronous, executed outside the transaction:action executed even if the notification returns an error. o Asynchronous:action in Project MonitorProject Monitor and the notification is sent immediately afterward. If an error occurs during notification, it is visible only in the pending orders and in the application log file. This is the recommended and default setting. For example, if a user modifies a property of a project, Project MonitorProject Monitor calls the web service specified by the associated webhook. If the system is in synchronous mode, Project MonitorProject Monitor waits for the web service to respond before completingaction returning control to the user. If an error occurs and the call is made within a transaction, the property update is rolled back; otherwise, if the call is made outside a transaction, the property update is still performed. If in asynchronous mode, the property modification is performed first, and the web service call is made afterward as task .

‣
Transaction executionTransaction execution

If the box is checked: The error preventsaction Project MonitorProject Monitor. If the checkbox is unchecked:action executed even if the notification returns an error. You can only check this box if the checkbox SynchronousSynchronous is checked.

‣
EventEvent

An event must be selected, such as an edit. Several fields must be filled in when selecting an event; a window will open. You can cancel or confirm your selection. Action Choose between All Actions, Create, Modify, and Delete. Object Type: Choose between Phase, Project, and User. Project Filter: Select a created project filter (private or public) or All Projects. If the object type is User, then no project filter should be selected.

🚩

If multilingual configuration is enabled, an additional field must be filled in a section Multilingual. This field corresponds to the object label in the other language.

Testing a webhook

🚦

This button appears once the 4 required fields (*) have been filled in.

A window appears when you click this button. You can choose a project, test the webhook, or cancel.

Apply

This feature is useful for applying your modifications while continuing to change information on the same page. This button is available when you are modifying an element that has already been created.

SeehistorySeehistory

Displays the list of changes made to this webhook by all users.

Actions are sorted from the most recent date to the oldest. This button is available when you edit an item that has already been created.

RegisterRegister

Validates your changes. This may redirect you to the previous page on some screens.

DeleteDelete

Allows you to delete a webhook.

🚦

Rights required : Delete a WebhookDelete a Webhook

‣

Non-exhaustive list of error/information messages

A technical error has occurred. Please contact your administrator.

Review of the formula for URL: https://webhook.site/eabc123abc123abcdid=404098

Request sent to https://webhook.site/eabc123abc123abcdid=404098 (status code: 404)