Guides

Creating an API Playbook

Suggest Edits

Before you can use DealHub’s Headless API for automated quote generation, contract renewals, or CRM-driven workflows, an administrator must complete setup steps in the DealHub UI. The API Playbook acts as the foundation for all headless operations, ensuring your products, pricing rules, and output documents are correctly configured for seamless automation.

🚧

Paid feature

The API Playbook is a paid feature and may need to be enabled for your account.

Step 1: Create and Configure the API Playbook

  1. Navigate to Version Settings and select the DRAFT version you intend to use.

  2. Navigate to the Playbooks section

  3. Click Create API Playbook. Give it a descriptive name (e.g., "Headless API").

📘

API Playbook

Unlike standard playbooks, API Playbooks have a simplified configuration, as they are not meant for direct user interaction.

Export Playbook Data (Optional)

Once the API Playbook is created, you can export its configuration for external use in JSON format. This can be useful for integrating with other systems, creating backups, or using the data as a reference for API development.

Two export options are available:

  • Playbook Data (JSON): Contains all details about the playbook, including configuration, settings, and associated data.

  • API Generate Request Template (JSON): A preformatted JSON template for constructing API requests related to the playbook functionality.

These files can be downloaded directly from the Playbooks section.

Step 2: Associate Products and Documents

Configurations do not carry over from other playbooks. You must manually associate all necessary components with your new API Playbook.

  1. Navigate to the Products section in Version Settings.

  2. Using the playbook selector at the top, switch to your newly created API Playbook.

  3. Enable and configure the rules for all products that will be used in the simulation.

  4. Navigate to the Output Documents section in Version Settings and associate at least one document template with the API Playbook.

Next Steps

Now that you learned how to configure your API Playbook, you can move forward to:

Updated about 1 month ago