Skip to main content

Projects

Project Notifications​

Project Notifications allow you to alert a potential external project management system of changes made by users on their Retail ops projects.

Project Workflow Validation ​

The Notification is triggered asynchronously when a Retail operations user does any operation that makes his project workflow evolve (i.e. move on step forward). Please refer the Project workflow section for more information about this notion.

warning

Since the Notification is asynchronous, the External system may not be immediately notified: it may take a short moment before the Webhook is triggered. Thus, Retail Ops does not expect nor manage any response from the External system.

Information transmitted​

The message sent to the URL subscribed to the notification contains the following information:

  • The name of the event triggered
  • The Identifier of the Project concerned
{
  "eventType": "workflow.validation",
  "entityTypeID": long,     // 0
  "entityID": long,         // Identifier of the relevant Project
}

The External System can call Retail Ops API in order to get more details about the related Project, by using the value of the entityID tag in order to fill in the projectID argument in methods such as:

Project Workflow Cancellation ​

Very similarly to the Project Workflow Validation notification above, this Notification is triggered asynchronously when a Retail operations user cancels a Workflow Transition in one of his projects (i.e. move on step backward).

warning

Since the Notification is asynchronous, the External system may not be immediately notified: it may take a short moment before the Webhook is triggered. Thus, Retail Ops does not expect nor manage any response from the External system.

Information transmitted​

The message sent to the URL subscribed to the notification contains the following information:

  • The name of the event triggered
  • The Identifier of the Project concerned
{
  "eventType": "workflow.cancellation",
  "entityTypeID": long,     // 0
  "entityID": long,         // Identifier of the relevant Project
}

The External System can call Retail Ops API in order to get more details about the related Project, by using the value of the entityID tag in order to fill in the projectID argument required in several methods, exactly like for the Project Workflow Validation notification above.