DealRoom Webhook Events Reference

This reference provides a list of all available DealRoom webhook event types and their associated action_summary messages.

Use these event keys and messages to parse incoming webhooks and trigger application logic based on customer and user actions within DealRoom.

Event Payload Structure

All DealRoom webhook events share a common payload structure. The specific activity is identified by the key and value inside the action_summary object.

{
  "event": "DEALROOM_EVENT",
  "DealRoom_URL": "https://...",
  "Dealhub_Opportunity_id": "OPP-123",
  "dealhub_quote_id": "QUOTE-456",
  "Event_source": "DealRoom",
  "executed_by": "John Doe",
  "Impersonated_By": "[email protected]",
  "execution_date": "2024-02-06 16:41:29",
  "action_summary": {
    "DEAL_BOX_FILE_ADDED": "John Doe added contract_final.pdf to the DealBox"
  }
}

📘
Optional Fields
Fields with no value in DealHub are omitted from the event payload entirely. For example, Impersonated_By is only present when an admin performed the action on behalf of another user.

Full Events List

The table below lists all supported webhook event triggers in the DealRoom module, grouped by functional area.

📘
Dynamic Placeholders
Values wrapped in double curly braces (e.g., {{ user }}, {{ filename }}) are dynamically populated by DealHub at runtime before the webhook is sent.

📘
Unknown Users
If the system cannot identify the actor (for example, an anonymous guest view), the executed_by field will be set to "Unknown".

Deal Box Events

Event Prefix	`action_summary` Message
`DEAL_BOX_FILE_ADDED`	{{ user }} added {{ filename }} to the DealBox
`DEAL_BOX_FILE_DELETED`	{{ user }} deleted {{ filename }} from the DealBox
`DEAL_BOX_FILE_DOWNLOADED`	{{ user }} downloaded {{ filename }} from the DealBox
`DEAL_BOX_FILE_COMMENTED`	{{ user }} added a comment to {{ filename }} in DealBox
`DEAL_BOX_FILES_SYNCED_TO_CRM`	{{ user }} synced DealBox files from DealRoom to the CRM account
`DEAL_BOX_DIRECTORY_CREATED`	{{ user }} created {{ filename }} in DealBox
`DEAL_BOX_DIRECTORY_DELETED`	{{ user }} deleted {{ filename }} from DealBox

Deal Management Events

Event Prefix	`action_summary` Message
`DEAL_VIEW`	{{ user }} viewed DealRoom
`DEAL_PUBLISH_NEW`	{{ user }} published new DealRoom
`DEAL_PUBLISH_NEW_USER`	{{ user }} published new DealRoom and shared with {{ user }}
`DEAL_PUBLISH_UPDATE`	{{ user }} published new version of DealRoom
`DEAL_PUBLISH_UPDATE_USER`	{{ user }} published new version of DealRoom shared with {{ user }}
`DEAL_SHARE`	{{ user }} shared DealRoom with {{ user }}
`DEAL_UNSHARE`	{{ user }} unshared {{ user }} from DealRoom
`DEAL_SIGN`	{{ user }} signed DealRoom
`DEAL_CO_SIGN`	{{ user }} signed DealRoom – {{ sigNum }} of {{ totalSigNum }} signatures
`DEAL_DOWNLOAD`	{{ user }} downloaded DealRoom document
`DEAL_JOIN_REQUEST`	{{ user }} requested access to DealRoom
`USER_SELF_JOINED_DEAL`	{{ user }} granted access to DealRoom
`DEAL_JOIN_APPROVED`	{{ user (approver) }} approved {{ user }} access to DealRoom
`DEAL_FORM_FILLED`	{{ user }} filled form in DealRoom
`DEAL_SEND_REMINDER`	{{ user }} sent reminder to {{ user }} in DealRoom
`DEAL_UNPUBLISH`	{{ user }} unpublished DealRoom
`DEAL_SIGN_EXTERNALLY`	{{ user }} signed DealRoom externally
`DEAL_SIGN_INTEGRATION_NOT_SIGNED`	{{ user }} closed signature window
`DEAL_SIGN_INTEGRATION_DECLINED`	{{ user }} declined to sign DealRoom

Document Management

Event Prefix	`action_summary` Message
`DEAL_EXTERNAL_DOCUMENT_UPLOAD`	{{ user }} upload and merge file {{ filename }}
`DEAL_EXTERNAL_DOCUMENT_DELETE`	{{ user }} delete merged file {{ filename }}

Online Redline Events

Event Prefix	`action_summary` Message
`DEAL_ENTERED_REDLINE`	DealRoom entered Redline editing mode for the first time
`REDLINE_SESSION_STARTED`	Redline editing started in DealRoom
`REDLINE_SESSION_ENDED`	Redline editing ended in DealRoom
`REDLINE_ACCEPTED`	1 of 2 approved Redline edits in DealRoom
`REDLINE_FULLY_ACCEPTED`	DealRoom Redline edits were approved

Revision Events

Event Prefix	`action_summary` Message
`REVISION_ADDED`	{{ user }} added revision {{ revisionNum }} to DealRoom
`REVISION_SIGNED`	{{ user }} signed revision {{ revisionNum }} in DealRoom
`REVISION_DOWNLOADED`	{{ user }} downloaded revision {{ revisionNum}} inDealRoom
`REVISION_RESTORED`	{{ user }} restored revision {{ revisionNum }} in DealRoom

📘
Event Filtering Best Practices
To reduce noise and simplify processing:

Filter on event prefix keys inside action_summary

React only to business-critical events such as:

DEAL_SIGN

REDLINE_FULLY_ACCEPTED

REVISION_SIGNED