Project Management Webhook

Project Management events via webhook

EMMi has an option to send Project management events via webhook instead of email notifications. Webhooks add a possibility to integrate and monitor the usage of the project management in EMMi. To receive notification via webhook a user is needed. The user has an option to define the endpoint to send the notifications and a token that is used to identify the source. The webhook only sends information about the event and the event-related id(s) eg. “Proof commented” and the ID of proof and project. The details or the changes done by a user have to be fetched via the REST API commands.

Webhook Parameters

These properties are given to a user account.

Parameter	Parameter Type	Mandatory	Description
Url	User Property	yes	Url where the webhook HTTP requests are sent
Token	User Property	no	Optional token to identify the source. The token is sent in a header as an “x-API-key” in the request

How to set up

Create user for webhook notifications
Create an endpoint for receiving the webhook notifications
(Optional) Create a token for the webhook
Send the user, endpoint and token information to our support helpdesk@emmi.fi
Add the user to a project(s) and start receiving webhook notifications

Output

The webhook output is in JSON. Below is a list of the output fields

Event object

Field	Description	Type
EventId	Id of the event	string
EventType	Type of the event	enum: FolderCreated FolderUpdated FolderDeleted FolderMoved FolderCopied FolderDetailsUpdated ProjectCreated ProjectUpdated ProjectDetailsUpdated ProjectDeleted ProjectMoved ProjectCopied ProjectStatusChanged ProjectScheduleChanged AssetCreated AssetDeleted AssetVersionAdded AssetImported AssetConvertedToProof AssetTypeChanged ProofCreated ProofDeleted ProofRenamed ProofVersionAdded ProofStatusChanged ProofCommented ProofCommentUpdated ProofCommentReplied ProofCommentDeleted ProofPublished ProofPublishedToNewAsset ProofShared ProofSharingCancelled ProofSharingAccepted ProofSharingDeclined ProofVersionDeleted MemberAdded MemberRemoved MemberUpdated MemberRoleChanged MessageCreated MessageUpdated MessageDeleted ReplyCreated ReplyUpdated ReplyDeleted ProofApproved ProofApprovedWithComments ProofRejected TaskCreated TaskResolved TaskReopened TaskDeadlineChange TaskAssigneeChange TaskUnassigned TaskDeleted TaskDeadlineReached TaskDeadlineReminder TaskUpdated MilestoneCreated MilestoneDeadlineChange MilestoneDeleted MilestoneDeadlineReached MilestoneDeadlineReminder MilestoneUpdated
EventTime	Time when the event happened	Unix timestamp
ProjectId	Id of the project, if the event occurred on project	string
FolderId	Id of the folder, if the event occurred on project folder	string
Targets		Array of target objects

Target object

Field	Description	Type
TargetId	Id of the target object (Proof id, if the target type is Proof etc.)	string
TargetType	Type of the target	enum: Asset ProjectMessage Project Proof User ProjectRole FileComment ProjectStatus ProofStatus ProjectTask ProjectMilestone ProjectAssetType ProjectFolder

Example

A commenter has given an opinion in a proof. Details about the changes can be fetched by the “Get Proof” or “Get Share” command.

{
  "EventId": "579",
  "EventType": "ProofApproved",
  "EventTime": 1629720919,
  "ProjectId": "7",
  "Targets": [
    {
      "TargetId": "13",
      "TargetType": "Proof"
    }
  ]
}

Feedback

Post your comment on this topic.