Collaboration Step

The Collaboration step lets you set up a multi-party document workflow. You define who the participants are, which document they are collaborating on, and an optional deadline. The step supports an owner party (your organization) and an optional external party, such as a partner or client.

Configuration

name	type	required	description
`documentStep`	string	yes	The `description` of the Document step that produces the document to collaborate on.
`documentName`	string	yes	Name of the document being collaborated on.
`dueDate`	string	no	Optional deadline for the collaboration (ISO 8601 date, e.g. `"2025-12-31"`).
`ownerParty`	object	yes	The owner party configuration. See Owner party below.
`externalParty`	object	no	Optional external party. See External party below.

A few things to note:

All email addresses must be unique across both parties—owner, participants, and external representative cannot share an email address.
At least one party (the owner) must always be defined.

Owner party

The owner party represents the primary organization or individual initiating the collaboration.

name	type	required	description
`owner`	object	yes	Main owner participant. See Participant fields below.
`participants`	array	no	Additional participants from the owner party.

External party

The external party represents a secondary organization or individual participating in the collaboration.

name	type	required	description
`representative`	object	yes	Main external party contact. See Participant fields below.
`participants`	array	no	Additional participants from the external party.

Participant fields

Both the owner/representative and any additional participants share the same set of fields.

name	type	required	description
`name`	string	no	Full name of the participant.
`email`	string	no	Email address of the participant.
`businessName`	string	no	Business or organization name (applicable to owner and representative).

Examples

Let's look at a complete setup with both an owner party and an external party collaborating on a service agreement.

{
  "documentStep": "step_001",
  "documentName": "Service Agreement 2025",
  "dueDate": "2025-12-31",
  "ownerParty": {
    "owner": {
      "name": "John Doe",
      "email": "[email protected]",
      "businessName": "Acme Corporation"
    },
    "participants": [
      {
        "name": "Jane Smith",
        "email": "[email protected]"
      },
      {
        "name": "Bob Wilson",
        "email": "[email protected]"
      }
    ]
  },
  "externalParty": {
    "representative": {
      "name": "Alice Johnson",
      "email": "[email protected]",
      "businessName": "Partner Company LLC"
    },
    "participants": [
      {
        "name": "Charlie Brown",
        "email": "[email protected]"
      }
    ]
  }
}

Here's a simpler setup with only the owner party—useful for internal reviews where no external party is involved.

{
  "documentStep": "step_002",
  "documentName": "Internal Review Document",
  "dueDate": "2025-11-15",
  "ownerParty": {
    "owner": {
      "name": "Sarah Davis",
      "email": "[email protected]",
      "businessName": "Internal Operations"
    },
    "participants": [
      {
        "name": "Michael Chen",
        "email": "[email protected]"
      }
    ]
  }
}