> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SpotDraft

> How to set up the SpotDraft connector, plus the actions and events that are available.

![SpotDraft](https://stackone-logos.com/api/spotdraft/filled/svg)

v3.0.0[See changelog](https://docs.stackone.com/connectors/spotdraft/changelog.md)

[99 actions](#actions) · [39 events](#events) · 2 auth methods

Contract Lifecycle Management

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Client Credentials · Connector Profile](https://docs.stackone.com/connectors/spotdraft/guides/connector-profile/client-credentials.md)
>
> SpotDraft uses dual custom HTTP headers (client-id and client-secret) for authentication. Credentials are generated from...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/spotdraft/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth client with SpotDraft's client registration endpoint. Requests run as the signed-in worksp...

Optionally, configure receiving Events for SpotDraft into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/spotdraft/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Client Credentials · Link Account](https://docs.stackone.com/connectors/spotdraft/guides/link-account/client-credentials.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/spotdraft/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Client Credentials

OAuth 2.0

No auth methods found

99 actions

ActionDescription

Get Contract Approvals`spotdraft_contracts_approvals_retrieve`

Get Contract Approvals.

Create And Send Adhoc Approvals`spotdraft_contracts_approvals_create`

Create and Send adhoc Approvals.

Get Comments In Contract Activity Log.`spotdraft_contracts_comments_retrieve`

Get Comments in Contract Activity Log.

Add Comment To Contract Activity Log.`spotdraft_contracts_comments_create`

Add Comment to Contract Activity Log.

Invite Users & Roles`spotdraft_contracts_invite_create`

Invite Users & Roles.

List Obligations`spotdraft_contracts_obligations_list`

List Obligations.

Create Obligation`spotdraft_contracts_obligations_create`

Create Obligation.

Get Obligation`spotdraft_contracts_obligations_retrieve_by_id`

Get Obligation.

Update Obligation`spotdraft_contracts_obligations_partial_update`

Update Obligation.

Delete Obligation`spotdraft_contracts_obligations_destroy`

Delete Obligation.

Get Contract Type List`spotdraft_contract_types_retrieve`

Get Contract Type List.

List Contract Type Entities`spotdraft_contract_types_entities_retrieve`

List Contract Type Entities.

List Contracts`spotdraft_list_contracts`

Retrieve a paginated list of contracts in the workspace.

Create Contract`spotdraft_create_contract`

Create a new contract from a template with specified data and counterparties.

Get Contract Status`spotdraft_get_contract_status`

Get the current status of a contract by its composite ID.

Get Contract Content`spotdraft_get_contract_content`

Retrieve the text content of a contract.

Download Contract`spotdraft_download_contract`

Download the contract file by composite ID.

Create Contract Download Link`spotdraft_create_contract_download_link`

Generate a download link for a contract file.

Send Contract To Counterparties`spotdraft_send_contract_to_counterparties`

Send a contract to its counterparties via email.

Void Contract`spotdraft_void_contract`

Void a contract by its composite ID.

Mark Contract For Execution`spotdraft_mark_contract_for_execution`

Mark a contract as ready for execution.

Resend Signatory Email`spotdraft_resend_signatory_email`

Resend the signing email to a contract signatory.

Update Contract Data`spotdraft_update_contract_data`

Update the data fields of an existing contract.

Update Contract Business User`spotdraft_update_contract_business_user`

Update the business user assigned to a contract.

Get Contract By External Metadata`spotdraft_get_contract_by_external_metadata`

List contracts associated with a given external metadata ID.

Preview Contract`spotdraft_preview_contract`

Generate a preview of a contract from a template.

Upload Contract For Review`spotdraft_upload_contract_for_review`

Upload an existing contract document for review in SpotDraft.

Upload Contract For Signature`spotdraft_upload_contract_for_signature`

Upload an existing contract document for signing in SpotDraft.

Upload Executed Contract`spotdraft_upload_executed_contract`

Upload an already-executed contract document to SpotDraft.

Get Contract Related Contracts`spotdraft_get_contract_related_contracts`

Get contracts related to a specific contract.

Create Contract Relation`spotdraft_create_contract_relation`

Create a relation between two contracts.

Get Contract Questionnaire Responses`spotdraft_get_contract_questionnaire_responses`

Get questionnaire responses for a contract.

Get Contract Authorized Users`spotdraft_get_contract_authorized_users`

Get the list of users authorized to access a contract.

Create Review Request`spotdraft_create_review_request`

Create a review request for a contract.

List Counterparties`spotdraft_counter_parties_list`

List Counterparties.

Create Counter Party`spotdraft_counter_parties_create`

Create Counter Party.

Get Counterparty`spotdraft_counter_parties_retrieve_by_id`

Get Counterparty.

Update Counterparty`spotdraft_counter_parties_partial_update`

Update Counterparty.

List Counterparty Contacts`spotdraft_counter_parties_contacts_retrieve`

List Counterparty Contacts.

Create Counterparty Contact`spotdraft_counter_parties_contacts_create`

Create Counterparty Contact.

Update Counterparty Contact`spotdraft_counter_parties_contacts_partial_update`

Update Counterparty Contact.

Delete Counterparty Contact`spotdraft_counter_parties_contacts_destroy`

Delete Counterparty Contact.

Contract Version Uploaded Webhook`spotdraft_webhook_contract_version_uploaded`

Processes SpotDraft CONTRACT\_VERSION\_UPLOADED activity events.

Contract Approval Completed Webhook`spotdraft_webhook_contract_approval_completed`

Processes SpotDraft CONTRACT\_APPROVAL\_COMPLETED activity events.

Contract Approval Requested Webhook`spotdraft_webhook_contract_approval_requested`

Processes SpotDraft CONTRACT\_APPROVAL\_REQUESTED activity events.

Contract Created Webhook`spotdraft_webhook_contract_created`

Processes SpotDraft CONTRACT\_CREATED activity events.

Contract Data Updated Webhook`spotdraft_webhook_contract_data_updated`

Processes SpotDraft CONTRACT\_DATA\_UPDATED activity events.

Contract Deleted Webhook`spotdraft_webhook_contract_deleted`

Processes SpotDraft CONTRACT\_DELETED activity events.

Contract Executed Webhook`spotdraft_webhook_contract_executed`

Processes SpotDraft CONTRACT\_EXECUTED activity events.

Contract Mark For Execution Webhook`spotdraft_webhook_contract_mark_for_execution`

Processes SpotDraft CONTRACT\_MARK\_FOR\_EXECUTION activity events.

Contract Sent To Counterparty Webhook`spotdraft_webhook_contract_sent_to_counterparty`

Processes SpotDraft CONTRACT\_SENT\_TO\_COUNTERPARTY activity events.

Contract Signature Declined Webhook`spotdraft_webhook_contract_signature_declined`

Processes SpotDraft CONTRACT\_SIGNATURE\_DECLINED activity events.

Contract Signature Requested Webhook`spotdraft_webhook_contract_signature_requested`

Processes SpotDraft CONTRACT\_SIGNATURE\_REQUESTED activity events.

Contract Signed Webhook`spotdraft_webhook_contract_signed`

Processes SpotDraft CONTRACT\_SIGNED activity events.

Contract Unmark For Execution Webhook`spotdraft_webhook_contract_unmark_for_execution`

Processes SpotDraft CONTRACT\_UNMARK\_FOR\_EXECUTION activity events.

Postmark Email Event Webhook`spotdraft_webhook_postmark_email_event`

Processes SpotDraft POSTMARK\_EMAIL\_EVENT activity events.

Contract Key Pointer Updation Webhook`spotdraft_webhook_contract_key_pointer_updation`

Processes SpotDraft CONTRACT\_KEY\_POINTER\_UPDATION activity events.

Contract Key Pointer Creation Webhook`spotdraft_webhook_contract_key_pointer_creation`

Processes SpotDraft CONTRACT\_KEY\_POINTER\_CREATION activity events.

Signing Email Delivered Webhook`spotdraft_webhook_signing_email_delivered`

Processes SpotDraft SIGNING\_EMAIL\_DELIVERED activity events.

Signing Email Opened Webhook`spotdraft_webhook_signing_email_opened`

Processes SpotDraft SIGNING\_EMAIL\_OPENED activity events.

Signing Email Not Delivered Webhook`spotdraft_webhook_signing_email_not_delivered`

Processes SpotDraft SIGNING\_EMAIL\_NOT\_DELIVERED activity events.

Signing Email Link Clicked Webhook`spotdraft_webhook_signing_email_link_clicked`

Processes SpotDraft SIGNING\_EMAIL\_LINK\_CLICKED activity events.

Redlining Email Delivered Webhook`spotdraft_webhook_redlining_email_delivered`

Processes SpotDraft REDLINING\_EMAIL\_DELIVERED activity events.

Redlining Email Opened Webhook`spotdraft_webhook_redlining_email_opened`

Processes SpotDraft REDLINING\_EMAIL\_OPENED activity events.

Redlining Email Not Delivered Webhook`spotdraft_webhook_redlining_email_not_delivered`

Processes SpotDraft REDLINING\_EMAIL\_NOT\_DELIVERED activity events.

Redlining Email Link Clicked Webhook`spotdraft_webhook_redlining_email_link_clicked`

Processes SpotDraft REDLINING\_EMAIL\_LINK\_CLICKED activity events.

Contract Signature Requested Notification Sent Webhook`spotdraft_webhook_contract_signature_requested_notification_sent`

Processes SpotDraft CONTRACT\_SIGNATURE\_REQUESTED\_NOTIFICATION\_SENT activity events.

Counter Party Created Webhook`spotdraft_webhook_counter_party_created`

Processes SpotDraft COUNTER\_PARTY\_CREATED activity events.

Counter Party Updated Webhook`spotdraft_webhook_counter_party_updated`

Processes SpotDraft COUNTER\_PARTY\_UPDATED activity events.

Counter Party Contact Created Webhook`spotdraft_webhook_counter_party_contact_created`

Processes SpotDraft COUNTER\_PARTY\_CONTACT\_CREATED activity events.

Counter Party Contact Updated Webhook`spotdraft_webhook_counter_party_contact_updated`

Processes SpotDraft COUNTER\_PARTY\_CONTACT\_UPDATED activity events.

Counter Party Address Created Webhook`spotdraft_webhook_counter_party_address_created`

Processes SpotDraft COUNTER\_PARTY\_ADDRESS\_CREATED activity events.

Counter Party Address Updated Webhook`spotdraft_webhook_counter_party_address_updated`

Processes SpotDraft COUNTER\_PARTY\_ADDRESS\_UPDATED activity events.

Contract Activity Log Comment Created Webhook`spotdraft_webhook_contract_activity_log_comment_created`

Processes SpotDraft CONTRACT\_ACTIVITY\_LOG\_COMMENT\_CREATED activity events.

Contract Voided Webhook`spotdraft_webhook_contract_voided`

Processes SpotDraft CONTRACT\_VOIDED activity events.

Contract Process Metric Updated Webhook`spotdraft_webhook_contract_process_metric_updated`

Processes SpotDraft CONTRACT\_PROCESS\_METRIC\_UPDATED activity events.

Contract External Metadata Created Webhook`spotdraft_webhook_contract_external_metadata_created`

Processes SpotDraft CONTRACT\_EXTERNAL\_METADATA\_CREATED activity events.

Contract External Metadata Updated Webhook`spotdraft_webhook_contract_external_metadata_updated`

Processes SpotDraft CONTRACT\_EXTERNAL\_METADATA\_UPDATED activity events.

Contract Entity Updated Webhook`spotdraft_webhook_contract_entity_updated`

Processes SpotDraft CONTRACT\_ENTITY\_UPDATED activity events.

Contract Review Requested Webhook`spotdraft_webhook_contract_review_requested`

Processes SpotDraft CONTRACT\_REVIEW\_REQUESTED activity events.

Contract Review Completed Webhook`spotdraft_webhook_contract_review_completed`

Processes SpotDraft CONTRACT\_REVIEW\_COMPLETED activity events.

List Legal Intakes`spotdraft_legal_intake_retrieve`

List legal intakes.

Get Legal Intake`spotdraft_legal_intake_retrieve_by_id`

Retrieve a specific legal intake by its ID.

Create Legal Intake`spotdraft_legal_intake_create`

Create legal intake.

Update Legal Intake`spotdraft_legal_intake_partial_update`

Update legal intake.

Delete Legal Intake`spotdraft_legal_intake_destroy`

Delete legal intake.

Get Organization Entities`spotdraft_organizations_entities_retrieve`

Get Organization Entities.

Create Entity`spotdraft_organizations_entities_create`

Create Entity.

Get Contract Recipients`spotdraft_contracts_recipients_retrieve`

Get Contract Recipients.

Get Recipient Link`spotdraft_contracts_recipients_recipient_link_retrieve`

Get Recipient Link.

Get Template List`spotdraft_templates_list`

Get Template List.

Get Template Details`spotdraft_templates_retrieve_by_id`

Get Template Details.

Get Template Metadata`spotdraft_templates_metadata_retrieve`

Get Template Metadata.

Update Template`spotdraft_templates_partial_update`

Update an existing contract template.

Get User List`spotdraft_auth_users_retrieve`

Get User List.

Create And Invite User`spotdraft_auth_users_create`

Create and Invite User.

Setup Webhook`spotdraft_webhooks_create`

Setup Webhook.

Get Webhook Secret`spotdraft_webhooks_hmac_key_get`

Get Webhook secret.

Remove Webhook`spotdraft_webhooks_destroy`

Remove Webhook.

## Events

Tags

Select all
|
Clear

Addresses

Comments

Contacts

Contracts

Counterparties

Emails

Webhooks

No tags found

39 events

EventDescriptionTags

Contract Version Uploaded Webhook`spotdraft_webhook_contract_version_uploaded`

Processes SpotDraft CONTRACT\_VERSION\_UPLOADED activity events.

ContractsWebhooks

Contract Approval Completed Webhook`spotdraft_webhook_contract_approval_completed`

Processes SpotDraft CONTRACT\_APPROVAL\_COMPLETED activity events.

ContractsWebhooks

Contract Approval Requested Webhook`spotdraft_webhook_contract_approval_requested`

Processes SpotDraft CONTRACT\_APPROVAL\_REQUESTED activity events.

ContractsWebhooks

Contract Created Webhook`spotdraft_webhook_contract_created`

Processes SpotDraft CONTRACT\_CREATED activity events.

ContractsWebhooks

Contract Data Updated Webhook`spotdraft_webhook_contract_data_updated`

Processes SpotDraft CONTRACT\_DATA\_UPDATED activity events.

ContractsWebhooks

Contract Deleted Webhook`spotdraft_webhook_contract_deleted`

Processes SpotDraft CONTRACT\_DELETED activity events.

ContractsWebhooks

Contract Executed Webhook`spotdraft_webhook_contract_executed`

Processes SpotDraft CONTRACT\_EXECUTED activity events.

ContractsWebhooks

Contract Mark For Execution Webhook`spotdraft_webhook_contract_mark_for_execution`

Processes SpotDraft CONTRACT\_MARK\_FOR\_EXECUTION activity events.

ContractsWebhooks

Contract Sent To Counterparty Webhook`spotdraft_webhook_contract_sent_to_counterparty`

Processes SpotDraft CONTRACT\_SENT\_TO\_COUNTERPARTY activity events.

ContractsWebhooks

Contract Signature Declined Webhook`spotdraft_webhook_contract_signature_declined`

Processes SpotDraft CONTRACT\_SIGNATURE\_DECLINED activity events.

ContractsWebhooks

Contract Signature Requested Webhook`spotdraft_webhook_contract_signature_requested`

Processes SpotDraft CONTRACT\_SIGNATURE\_REQUESTED activity events.

ContractsWebhooks

Contract Signed Webhook`spotdraft_webhook_contract_signed`

Processes SpotDraft CONTRACT\_SIGNED activity events.

ContractsWebhooks

Contract Unmark For Execution Webhook`spotdraft_webhook_contract_unmark_for_execution`

Processes SpotDraft CONTRACT\_UNMARK\_FOR\_EXECUTION activity events.

ContractsWebhooks

Postmark Email Event Webhook`spotdraft_webhook_postmark_email_event`

Processes SpotDraft POSTMARK\_EMAIL\_EVENT activity events.

EmailsWebhooks

Contract Key Pointer Updation Webhook`spotdraft_webhook_contract_key_pointer_updation`

Processes SpotDraft CONTRACT\_KEY\_POINTER\_UPDATION activity events.

ContractsWebhooks

Contract Key Pointer Creation Webhook`spotdraft_webhook_contract_key_pointer_creation`

Processes SpotDraft CONTRACT\_KEY\_POINTER\_CREATION activity events.

ContractsWebhooks

Signing Email Delivered Webhook`spotdraft_webhook_signing_email_delivered`

Processes SpotDraft SIGNING\_EMAIL\_DELIVERED activity events.

EmailsWebhooks

Signing Email Opened Webhook`spotdraft_webhook_signing_email_opened`

Processes SpotDraft SIGNING\_EMAIL\_OPENED activity events.

EmailsWebhooks

Signing Email Not Delivered Webhook`spotdraft_webhook_signing_email_not_delivered`

Processes SpotDraft SIGNING\_EMAIL\_NOT\_DELIVERED activity events.

EmailsWebhooks

Signing Email Link Clicked Webhook`spotdraft_webhook_signing_email_link_clicked`

Processes SpotDraft SIGNING\_EMAIL\_LINK\_CLICKED activity events.

EmailsWebhooks

Redlining Email Delivered Webhook`spotdraft_webhook_redlining_email_delivered`

Processes SpotDraft REDLINING\_EMAIL\_DELIVERED activity events.

EmailsWebhooks

Redlining Email Opened Webhook`spotdraft_webhook_redlining_email_opened`

Processes SpotDraft REDLINING\_EMAIL\_OPENED activity events.

EmailsWebhooks

Redlining Email Not Delivered Webhook`spotdraft_webhook_redlining_email_not_delivered`

Processes SpotDraft REDLINING\_EMAIL\_NOT\_DELIVERED activity events.

EmailsWebhooks

Redlining Email Link Clicked Webhook`spotdraft_webhook_redlining_email_link_clicked`

Processes SpotDraft REDLINING\_EMAIL\_LINK\_CLICKED activity events.

EmailsWebhooks

Contract Signature Requested Notification Sent Webhook`spotdraft_webhook_contract_signature_requested_notification_sent`

Processes SpotDraft CONTRACT\_SIGNATURE\_REQUESTED\_NOTIFICATION\_SENT activity events.

ContractsWebhooks

Counter Party Created Webhook`spotdraft_webhook_counter_party_created`

Processes SpotDraft COUNTER\_PARTY\_CREATED activity events.

CounterpartiesWebhooks

Counter Party Updated Webhook`spotdraft_webhook_counter_party_updated`

Processes SpotDraft COUNTER\_PARTY\_UPDATED activity events.

CounterpartiesWebhooks

Counter Party Contact Created Webhook`spotdraft_webhook_counter_party_contact_created`

Processes SpotDraft COUNTER\_PARTY\_CONTACT\_CREATED activity events.

CounterpartiesContactsWebhooks

Counter Party Contact Updated Webhook`spotdraft_webhook_counter_party_contact_updated`

Processes SpotDraft COUNTER\_PARTY\_CONTACT\_UPDATED activity events.

CounterpartiesContactsWebhooks

Counter Party Address Created Webhook`spotdraft_webhook_counter_party_address_created`

Processes SpotDraft COUNTER\_PARTY\_ADDRESS\_CREATED activity events.

CounterpartiesAddressesWebhooks

Counter Party Address Updated Webhook`spotdraft_webhook_counter_party_address_updated`

Processes SpotDraft COUNTER\_PARTY\_ADDRESS\_UPDATED activity events.

CounterpartiesAddressesWebhooks

Contract Activity Log Comment Created Webhook`spotdraft_webhook_contract_activity_log_comment_created`

Processes SpotDraft CONTRACT\_ACTIVITY\_LOG\_COMMENT\_CREATED activity events.

ContractsCommentsWebhooks

Contract Voided Webhook`spotdraft_webhook_contract_voided`

Processes SpotDraft CONTRACT\_VOIDED activity events.

ContractsWebhooks

Contract Process Metric Updated Webhook`spotdraft_webhook_contract_process_metric_updated`

Processes SpotDraft CONTRACT\_PROCESS\_METRIC\_UPDATED activity events.

ContractsWebhooks

Contract External Metadata Created Webhook`spotdraft_webhook_contract_external_metadata_created`

Processes SpotDraft CONTRACT\_EXTERNAL\_METADATA\_CREATED activity events.

ContractsWebhooks

Contract External Metadata Updated Webhook`spotdraft_webhook_contract_external_metadata_updated`

Processes SpotDraft CONTRACT\_EXTERNAL\_METADATA\_UPDATED activity events.

ContractsWebhooks

Contract Entity Updated Webhook`spotdraft_webhook_contract_entity_updated`

Processes SpotDraft CONTRACT\_ENTITY\_UPDATED activity events.

ContractsWebhooks

Contract Review Requested Webhook`spotdraft_webhook_contract_review_requested`

Processes SpotDraft CONTRACT\_REVIEW\_REQUESTED activity events.

ContractsWebhooks

Contract Review Completed Webhook`spotdraft_webhook_contract_review_completed`

Processes SpotDraft CONTRACT\_REVIEW\_COMPLETED activity events.

ContractsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.