Skip to main content
Deals are the core records in Essal Sales. A deal represents a potential business opportunity, linked to one or more contacts and progressing through a pipeline. This guide covers creating deals, logging activity, and reading deal summaries.

Creating a Deal

Logging Activities

Track all deal-related interactions in the activity log:
Supported activity types: call, email, meeting, note, task.

Retrieving the Activity Timeline

Each activity entry includes the type, author, timestamp, and note. Activities are immutable once created.

Closing a Deal

Mark a deal as won or lost. Both transitions require a close_reason:
Closing fires either a sales.deal.won or sales.deal.lost event, which can trigger downstream automation — for example, kicking off project creation in Essal Project.
Link a deal to an Essal Project at close-time using the linked_resources field on the project object. This gives your delivery team direct context on the business opportunity they are delivering.

Deal Summary

Get a structured summary of a deal suitable for embedding in dashboards:
The summary response includes the deal’s current stage, weighted value, activity count, days since last activity, and next scheduled task.