Skip to main content
Contractbook logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: CONTRACTBOOK
  • Version: 20261101_00

Tools

Slug: CONTRACTBOOK_CREATE_DOCUMENT_FROM_TEMPLATECreate a draft document from a Contractbook template, optionally overriding its document fields; this does not send the draft for signature.

Input Parameters

array
Tags assigned to the draft; each tag must be a non-empty string.
string
Draft title override.
string
Draft message content override.
array
Party and signee overrides for the draft.
string
Draft language code override.
array
Attachments to put on the draft using already-hosted Contractbook-compatible URLs.
array
Template data-field values and definitions to apply; omitted conditional fields resolve as false in template conditions.
string
required
Template ID used to create the draft.
array
Values used to fill dynamic-table placeholders in the template.
string ("owner_and_others" | "others_only" | "owner_only")
Who must sign the draft.
string
Company logo URL override; pass null to remove the logo.
string ("random" | "strict" | "grouped")
Draft signing order mode override.
boolean
Whether draft attachments are signed and sealed separately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_DELETE_DOCUMENTPermanently destroy a Contractbook document with no restore option. Signed documents cannot be deleted through this API; Contractbook rejects signed or otherwise undeletable documents rather than reporting success.

Input Parameters

string
required
ID of the Contractbook document to permanently destroy. This cannot be undone, and signed documents cannot be deleted through this API. Retrieve the document first if its identity or state is uncertain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_GET_DOCUMENTGet the current Contractbook document, including its version when available for a safe update.

Input Parameters

string
required
Contractbook document ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_GET_TEMPLATEGet a template’s full fields, parties, attachments, and signing configuration before creating a draft from it.

Input Parameters

string
required
Contractbook template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_LIST_AUTOMATIONSList Contractbook automations for one trigger type; this only discovers automations and does not run them.

Input Parameters

string ("webhook_trigger" | "hubspot_contractbook_automation_triggered" | "hubspot_deal_stage_changed" | "contract_signed" | "contract_verified_ai" | "contract_viewed" | "data_field_date_reached" | "data_field_updated" | "draft_created" | "draft_updated" | "drafter_questionnaire_completed" | "sent_for_signature" | "task_due_date_reached" | "task_is_done" | "pipedrive_deal_stage_changed" | "salesforce_flow_executed" | "salesforce_opportunity_stage_changed")
required
Trigger type whose published automations to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_LIST_DOCUMENTSSearch and filter documents visible to the connected Contractbook account, returning one page and a cursor for continuation. By default, searches are limited to my documents; team and workspace contexts can also be selected.

Input Parameters

boolean
Include data fields and full party details in each result.
array
Tags used to filter documents.
boolean
When set, filter by whether the connected account owns the document.
string
Case-insensitive partial title to match.
string
Opaque next_cursor returned by a previous call; omit for the first page.
array
Document states to include.
array
Document areas to search; include all three values to search every available area.
integer
Maximum documents in this page (0-100).
string ("created_at" | "updated_at" | "title")
Field used to sort results.
string
Workspace ID to filter when contexts includes workspace.
string
Return documents signed before this timestamp, excluding the boundary.
array
Document types to include.
string ("asc" | "desc")
Sort direction.
string
Return documents updated before this timestamp, excluding the boundary.
string
Return documents signed at or after this timestamp.
string
Return documents updated at or after this timestamp.
string
External integration object ID associated with documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_LIST_TEMPLATESList Contractbook templates visible to the connected account for choosing a template ID, optionally excluding templates in spaces.

Input Parameters

boolean
Exclude templates located in spaces when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CONTRACTBOOK_UPDATE_DOCUMENTUpdate selected fields of a draft or stored contract using its current version; supplied collection fields replace their complete existing collections.

Input Parameters

array
Complete replacement tag list; fetch and merge first to preserve existing tags.
string
Replacement document title.
string
Replacement document message content.
array
Complete replacement party and signee list; fetch and merge first to preserve parties.
string
required
Current document version from GET_DOCUMENT or a recent document response; stale values fail with version_mismatch.
string
Replacement document language code; pass null only when intentionally clearing it.
array
Complete replacement attachment list using Contractbook attachment objects; fetch and merge first to preserve existing attachments. Pass null only when intentionally clearing it.
array
Complete replacement data-field list; fetch and merge first to preserve fields.
string
required
Draft or stored-contract document ID.
array
Complete replacement dynamic-table definitions with attrs containing id, columns, and rows.
string ("owner_and_others" | "others_only" | "owner_only")
Who must sign the document.
string
Replacement company logo URL; pass null only when intentionally clearing it.
string ("random" | "strict" | "grouped")
Replacement signing order mode.
boolean
Whether attachments are signed separately from the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not