Help

Reference

Reference describes how Drum is put together. Use it to look up a permission, a merge field, an API endpoint, or another fact about the product.

It does not walk you through a task. For steps, use a how-to guide. For background on why something works the way it does, see explanation.

API

  • Authentication and permissions: How API tokens work, the four API permissions, and which records a token can see.

  • Requests, errors and limits: Pagination, request bodies, error bodies, money and date formats, idempotency keys, and rate limits for the Drum API.

  • Accounts and me: Read the token’s user, and list the Drum accounts that user belongs to.

  • Projects: List and read delivery projects, with their deliverables, tasks, contacts, addresses and custom fields.

  • Tasks: Change the status, dates, note and assigned members of one task on a project or opportunity.

  • Opportunities: List, read, create, update and convert sales opportunities, and edit their deliverables and tasks.

  • Tracked times: Read, log, change and delete time entries on projects, and leave, overhead and time credit time.

  • Costs: Read, create and change project costs and their line items, add expense claim receipts, and attach files.

  • Invoices and write-offs: Read invoices and write-offs, and allocate an existing Xero invoice to a project.

  • Planned invoices: Read the invoices a firm plans to raise on its projects.

  • Lookup lists: The lists an integration reads to find valid ids, such as statuses, lead scores, cost types, finance accounts and members.

  • Companies and contacts: List, read, create, change and merge companies, and manage contacts and their links to companies, opportunities and projects.

  • Notes: List, read, add, change, delete and restore the notes on a project, opportunity, company, contact or other record.

  • Proposals: Read a live proposal, edit its proposal document, read its sent versions, send it by email, and read the client’s signed answers.

  • Proposal budgets: Add, change and delete the phases, deliverables, tasks, resource lines and cost lines of a live proposal’s budget, one row at a time.

  • Account settings: Read an account’s setup catalog, change Project Settings and Opportunity Settings, and set proposal numbering. Also the rules shared by every setup endpoint.

  • Templates: Read, create, change, delete and restore deliverable templates and project templates, and edit their tasks, lines, phases, statuses, lead scores and custom fields one row at a time.

  • Proposal templates: Read, create, change, delete and restore proposal templates, and edit their quote sections, notes, custom rate card and budget.

  • Settings catalogs: List, read, create, change, delete and restore custom fields, resource types, cost types, rate cards, project roles, booking types and milestone types.

Webhooks

  • Events: Every webhook event, when it fires, the rules for project and opportunity events, how update events are combined, and the events an event trigger can send.

  • Payloads: The JSON body of each webhook event, with the attributes of projects, opportunities, invoices, costs and companies, and of every record an event trigger can send.

  • Requests and signatures: The HTTP request Drum sends for each webhook delivery, its headers and body envelope, and how the X-Webhook-Signature header is built.

  • Delivery and retries: Which URLs Drum sends to, timeouts, what counts as success, automatic retries, failures, auto-disable, duplicate suppression and how long deliveries are kept.

  • Subscription endpoints: The REST API endpoints that create, read, change, pause, resume and delete webhook subscriptions, and read and retry their deliveries.

MCP server

  • Server and protocol: The Drum MCP endpoint, the protocol versions and JSON-RPC methods it supports, and the instructions it sends to the AI.

  • Authentication and permissions: Sign in with Drum (OAuth) and API tokens for the MCP server, the OAuth scopes, and the checks that decide which tools a client sees.

  • Toolsets: The eight MCP toolsets, the tools in each, and how a connection or API token stores its selection.

  • Supported clients: The AI clients that can connect to Drum’s MCP server, and whether each uses Sign in with Drum or an API token.

  • Results, errors and limits: How MCP tool results are shaped, how pages and idempotency keys work, the tool error codes, and the rate limits.

  • Example prompts: Things you can ask an AI assistant connected to Drum, by toolset, with the tools it will use.

  • Search, delete and restore tools: search_records, which finds the id of any record, and delete_record and restore_record, which delete and restore records of many kinds.

  • My work tools: Tools in the My work toolset: projects, time entries, tasks, costs, receipts, expense claims, notes and Beats.

  • Sales tools: Tools in the Sales toolset: opportunities and their rows, conversion to projects, and live proposal budgets.

  • Clients tools: Tools in the Clients toolset: companies, contacts and their links to records, and notes.

  • Proposals tools: Tools in the Proposals toolset: proposal documents, their sections and pricing layout, sending, and signed proposals.

  • Insights tools: Tools in the Insights toolset: the overview, revenue and receivables reports.

  • Setup tools: Tools in the Setup toolset: account settings, settings catalogs and proposal numbering.

  • Templates tools: Tools in the Templates toolset: deliverable templates, and project and opportunity templates, with their rows.

  • Proposal templates tools: Tools in the Proposal templates toolset: proposal templates with their budgets, quotes, notes and custom rate cards.