Webhook payload schema

All DataRoom webhook payloads include event and createdAt.

Common fields (present in every payload)

Field	Type	Description
`event`	string	Event type identifier. One of the DataRoom webhook event names listed below.
`createdAt`	string	Event creation timestamp in RFC 3339 / ISO 8601 format (e.g., `2024-01-15T10:30:00Z`).
`actor`	string	Email of the entity that triggered the event. For UI-triggered actions this is the acting user's email; for API-triggered actions this is the service-account email. Consumers can use this to distinguish API-triggered events from UI-triggered events and avoid over-processing self-triggered events.

User join

Event: dataroom.user.join

Description: Fired when a user joins a data room.

JSON body

{
  "event": "dataroom.user.join",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "email": "string",
  "groupIds": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`email`	string	User email.
`groupIds`	string[]	Group IDs the user belongs to at the time of join.
`actor`	string	See common fields. For self-triggered joins, `actor` equals `email`.

Users are added to a group

Event: dataroom.user.add_to_group

Description: Fired when one or more users are added to a specific group in a data room.

JSON body

{
  "event": "dataroom.user.add_to_group",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "emails": ["string"],
  "groupId": "string",
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`emails`	string[]	User emails added to the group.
`groupId`	string	Group identifier.
`actor`	string	See common fields.

Users are removed from a group

Event: dataroom.user.remove_from_group

Description: Fired when a user is removed from a specific group in a data room.

JSON body

{
  "event": "dataroom.user.remove_from_group",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "emails": ["string"],
  "groupId": "string",
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`emails`	string[]	User email removed from the group.
`groupId`	string	Group identifier.
`actor`	string	See common fields.

Users are removed

Event: dataroom.user.removed

Description: Fired when one or more users are removed from a data room.

JSON body

{
  "event": "dataroom.user.removed",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "emails": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`emails`	string[]	User emails removed from the data room.
`actor`	string	See common fields.

Users are invited

Event: dataroom.user.invited

Description: Fired when one or more users are invited to a data room (optionally with group assignments).

JSON body

{
  "event": "dataroom.user.invited",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "emails": ["string"],
  "groupIds": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`emails`	string[]	User emails invited to the data room.
`groupIds`	string[]	Group IDs assigned to the invited users.
`actor`	string	See common fields.

An user declines invitation

Event: dataroom.user.decline_invitation

Description: Fired when a user declines a data room invitation.

JSON body

{
  "event": "dataroom.user.decline_invitation",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "email": "string",
  "groupIds": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`email`	string	User email that declined the invitation.
`groupIds`	string[]	Group IDs associated with the invitation.
`actor`	string	See common fields. For self-triggered declines, `actor` equals `email`.

Group created

Event: dataroom.group.created

Description: Fired when a group is created in a data room.

JSON body

{
  "event": "dataroom.group.created",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "groupId": "string",
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`groupId`	string	Group identifier created in the data room.
`actor`	string	See common fields.

Group Deleted

Event: dataroom.group.deleted

Description: Fired when a group is deleted from a data room.

JSON body

{
  "event": "dataroom.group.deleted",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "groupId": "string",
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`groupId`	string	Group identifier deleted from the data room.
`actor`	string	See common fields.

View Document

Event: dataroom.document.viewed

Description: Fired when a participant views one or more documents in a data room.

JSON body

{
  "event": "dataroom.document.viewed",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "email": "string",
  "groupIds": ["string"],
  "documentIds": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`email`	string	Participant email who viewed the document(s).
`groupIds`	string[]	Group IDs the participant belongs to at the time of the event.
`documentIds`	string[]	Document identifiers viewed.
`actor`	string	See common fields. For viewer-triggered views, `actor` equals `email`.

Download document

Event: dataroom.document.downloaded

Description: Fired when a participant downloads one or more documents from a data room.

JSON body

{
  "event": "dataroom.document.downloaded",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "email": "string",
  "groupIds": ["string"],
  "documentIds": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Description
`dataRoomId`	string	Data room identifier.
`email`	string	Participant email who downloaded the document(s).
`groupIds`	string[]	Group IDs the participant belongs to at the time of the event.
`documentIds`	string[]	Document identifiers downloaded.
`actor`	string	See common fields. For downloader-triggered downloads, `actor` equals `email`.

User Invitation Reminded

Event: dataroom.user.invitation_reminded

Description: Fired when invitation reminder(s) are sent to one or more participants for a data room.

JSON body

{
  "event": "dataroom.user.invitation_reminded",
  "createdAt": "2024-01-15T10:30:00Z",
  "dataRoomId": "string",
  "emails": ["string"],
  "actor": "string"
}

Field definitions

Field	Type	Descriptions
`dataRoomId`	string	Data room identifier.
`emails`	string[]	Participant emails that the reminder was sent to.
`actor`	string	See common fields.