Skip to main content
Close logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 45
  • Slug: CLOSE
  • Version: 20261101_00

Tools

Slug: CLOSE_CREATE_CALLCreates a new call record in Close.com. This tool allows you to log both inbound and outbound calls associated with a lead, supporting parameters such as lead_id, direction, and optional support for contact_id, phone, duration, note, recording_url, and user_id.

Input Parameters

string
A text note about the call
string
The phone number associated with the call
string
required
The ID of the lead associated with the call Must reference an existing lead; an incorrect ID silently attaches the call to the wrong lead.
string
The ID of the user who made/received the call
integer
Duration of the call in seconds
string ("outbound" | "inbound")
required
The direction of the call (outbound or inbound)
string
The ID of the contact associated with the call
string ("answered" | "no-answer" | "vm-answer" | "vm-left" | "busy" | "blocked" | "error" | "abandoned")
The outcome of the call (answered, no-answer, vm-answer, vm-left, busy, blocked, error, abandoned)
string
HTTPS URL pointing to the MP3 recording of the call

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: CLOSE_CREATE_EMAILCreate or log a Close email activity. Draft creates an unsent activity. Scheduled and outbox are send-capable modes that can deliver email externally; inbox, sent, and error log outcomes. Setting followup_date can also create a follow-up task if no reply is received.

Input Parameters

array
CC recipient email addresses.
array
Primary recipient email addresses.
array
BCC recipient email addresses.
string
Sender address, optionally formatted with a display name. Required for inbox, scheduled, outbox, and error; optional for draft and sent.
string ("inbox" | "draft" | "scheduled" | "outbox" | "sent" | "error")
required
Email mode. inbox, sent, and error log existing outcomes; draft creates without sending; scheduled sends externally at date_scheduled; outbox sends externally now or after send_in.
string
required
ID of the lead to associate with the email. Verify it before creation because a valid but wrong ID silently misassociates the activity.
integer
Seconds to delay an outbox external send, from 0 through 59. Valid only for outbox.
string
Email subject.
string
Close user ID associated with the email.
string
HTML email body. Omit both body fields when template_id should be rendered server-side.
string
Plain-text email body. Omit both body fields when template_id should be rendered server-side.
string
Contact ID to associate with the email.
string
ISO 8601 datetime when the email activity occurred.
array
Files previously uploaded to Close to attach to this email.
string
Close email template ID. If both body fields are omitted, Close renders this template server-side.
string
ISO 8601 creation datetime when logging an existing email.
string
ISO 8601 datetime for Close to create a follow-up task if no reply is received. Valid only for scheduled, outbox, or sent.
string
ISO 8601 send datetime. Required only for scheduled, which causes future external delivery.
string
Email activity ID this message replies to.
string
Close email account ID used for the activity or outbound delivery.
string
Sequence ID associated with the email follow-up.

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: CLOSE_CREATE_LEADCreates a new lead in Close CRM. A lead represents a company or organization in your sales pipeline. This tool allows you to create leads with company information (name, description, website), associate contacts with emails/phones/URLs, add addresses, and set the lead status. Contacts and addresses can be nested in the lead creation request. The tool returns comprehensive lead information including the lead ID, direct URL to view in Close CRM, associated contacts with their IDs, addresses, status information, and creation/update timestamps. Note: Activities, tasks, and opportunities must be created separately after lead creation.

Input Parameters

string
Website URL of the company
string
required
Name of the company/lead
array
List of contacts associated with the lead
array
List of addresses associated with the lead
string
ID of the lead status. If not provided, organization’s default status will be used
string
Description of the lead

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: CLOSE_CREATE_OPPORTUNITYCreate a Close sales opportunity on an existing lead, or create an Untitled lead for it when lead_id is omitted.

Input Parameters

string
Plain-text or Markdown note.
integer
Monetary opportunity value in cents.
string
ID of an existing lead; omit it to let Close create an Untitled lead.
string
ID of the Close user assigned to the opportunity.
string
ISO 8601 won timestamp; Close may set it from a won status.
string
Rich-text HTML note.
string
Initial opportunity status ID.
integer
Opportunity confidence percentage.
string
ID of the contact associated with the opportunity.
string
ID of the Close user recorded as the creator.
array
Uploaded attachment references to include.
string
Pipeline ID used to select the default or specified status.
string
ISO 8601 opportunity creation timestamp.
string ("one_time" | "monthly" | "annual")
Period over which the opportunity value applies.
object
Bare custom field IDs mapped to values for the opportunity.

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: CLOSE_CREATE_SMSCreate an SMS activity on a Close lead to log received, sent, or draft messages, or to send or schedule a message. The local phone number must be an SMS-enabled internal number owned by your Close organization; sending with outbox or scheduled status requires A2P 10DLC compliance.

Input Parameters

string
required
The content of the SMS message
string ("inbox" | "draft" | "scheduled" | "outbox" | "sent")
required
The status of the SMS. Must be one of: inbox, draft, scheduled, outbox, sent
string
required
The ID of the lead associated with the SMS Verify the lead_id before submission — an incorrect ID causes silent misassociation with no error returned.
integer
Number of seconds to delay sending the SMS when status is outbox. Must be less than 60
string ("inbound" | "outbound")
The direction of the SMS. Defaults to ‘inbound’ if status is inbox, otherwise ‘outbound’
string
The ID of the contact associated with the SMS
string
required
The internal phone number used to send the SMS. Must be associated with a Phone Number of type ‘internal’
string
The ID of an SMS Template to render and use as the message content
string
required
The recipient’s phone number
string
The date and time when the SMS should be sent (required if status is ‘scheduled’)

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: CLOSE_CREATE_TASKCreate a Close task associated with a lead, using task text and an actionable date, with optional completion status and assignment.

Input Parameters

string
required
The date when the task is actionable. Can be date-only (YYYY-MM-DD) or date-time (YYYY-MM-DDThh:mm:ss+00:00)
string
required
Description of the task
string
Type of task to create. Must be either ‘lead’ (a to-do item for a sales rep) or ‘outgoing_call’ (a call task). Defaults to ‘lead’
string
required
The ID of the lead the task is associated with An incorrect but valid lead_id silently associates the task with the wrong lead.
string
User ID of the person the task is assigned to. If omitted, assigns to the API caller
boolean
Whether the task is complete

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: CLOSE_DELETE_ACTIVITY_CUSTOM_FIELDPermanently delete one Close activity custom-field definition by ID.

Input Parameters

string
required
The unique identifier of the activity custom-field definition to delete

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: CLOSE_DELETE_CALLThis tool allows you to delete a specific call activity in Close.com. It is useful for removing incorrectly logged calls or cleaning up call records. The action deletes a call activity using its unique call ID and cannot be undone.

Input Parameters

string
required
The unique identifier of the call activity to delete

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: CLOSE_DELETE_CUSTOM_ACTIVITYPermanently delete one Close custom activity instance by ID.

Input Parameters

string
required
The unique identifier of the custom activity instance to delete.

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: CLOSE_DELETE_EMAILThis tool allows you to permanently delete a specific email activity in Close.com. It is useful for removing duplicate or incorrectly logged email activities. The action deletes an email activity using its unique email ID and cannot be undone.

Input Parameters

string
required
The unique identifier of the email activity to delete

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: CLOSE_DELETE_LEADPermanently delete one Close lead by ID.

Input Parameters

string
required
The unique identifier of the lead to delete

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: CLOSE_DELETE_LEAD_CUSTOM_FIELDPermanently delete a Close lead custom-field definition and its values.

Input Parameters

string
required
ID of the lead custom-field definition to permanently delete.

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: CLOSE_DELETE_NOTEPermanently delete one Close note activity by ID.

Input Parameters

string
required
The unique identifier of the note activity to delete

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: CLOSE_DELETE_OPPORTUNITYPermanently delete one Close opportunity by ID.

Input Parameters

string
required
The unique identifier of the opportunity to delete

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: CLOSE_GET_CALLRetrieve one Close call activity by ID with optional field projection.

Input Parameters

array
Call field names to include in the response.
string
required
ID of the call activity to retrieve.

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: CLOSE_GET_CONTACTRetrieve one Close contact by ID, optionally limiting returned fields.

Input Parameters

array
Response field names to include. Omit to return the provider’s default contact fields.
string
required
ID of the contact to retrieve.

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: CLOSE_GET_EMAILRetrieve one Close email activity by ID with optional field projection.

Input Parameters

array
Email field names to include in the response.
string
required
ID of the email activity to retrieve.

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: CLOSE_GET_LEADRetrieve one Close lead by ID with optional field projection.

Input Parameters

array
Response field names to include.
string
required
ID of the lead to retrieve.

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: CLOSE_GET_NOTEThis tool retrieves a list of note activities from Close. It allows users to fetch notes with optional filtering parameters, including filtering by lead_id, user_id, and date ranges. The tool returns details such as note content, creation and update dates, and any associated attachments.

Input Parameters

integer
Number of results to skip for pagination (maps to _skip API parameter). Use together with limit to page through results.
integer
Maximum number of results to return per page (maps to _limit API parameter). Use together with skip to page through results.
string
Filter notes by a specific lead ID An incorrect lead_id silently returns notes for the wrong lead rather than raising an error; verify the lead_id before filtering.
string
Filter notes by a specific user ID
string
Filter notes created after this date (ISO 8601 format)
string
Filter notes created before this date (ISO 8601 format)

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: CLOSE_GET_OPPORTUNITYRetrieve one Close opportunity by ID with optional field projection.

Input Parameters

array
Response field names to include.
string
required
ID of the opportunity to retrieve.

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: CLOSE_GET_SMSRetrieve one Close SMS activity by ID with optional field projection.

Input Parameters

array
SMS field names to include in the response.
string
required
ID of the SMS activity to retrieve.

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: CLOSE_LIST_ACTIVITIESLists one page of Close email or call activities using documented filters.

Input Parameters

integer
Number of matching activities to skip before this page.
integer
Maximum activities to return in this page. Close does not publish a subtype-specific maximum.
array
Response field names to include. Use projection to reduce large activity payloads.
array
Lead IDs whose activities should be returned.
string ("date_created" | "-date_created" | "activity_at" | "-activity_at")
Sort field, optionally descending with ’-’. Activity-at ordering requires exactly one lead ID.
array
Close user IDs whose activities should be returned.
array
Contact IDs whose activities should be returned.
array
Activity IDs to include.
string ("email" | "call")
required
Activity subtype to return; selects the email or call endpoint.
string
Include activities that occurred strictly after this ISO 8601 date or datetime; requires order_by=-activity_at and exactly one lead ID.
string
Include activities that occurred strictly before this ISO 8601 date or datetime; requires order_by=-activity_at and exactly one lead ID.
string
Include activities that occurred at or after this ISO 8601 date or datetime; requires order_by=-activity_at and exactly one lead ID.
string
Include activities that occurred at or before this ISO 8601 date or datetime; requires order_by=-activity_at and exactly one lead ID.
string
Include activities created strictly after this ISO 8601 date or datetime.
string
Include activities created strictly before this ISO 8601 date or datetime.
string
Organization ID to filter activities by.
string
Include activities created at or after this ISO 8601 date or datetime.
string
Include activities created at or before this ISO 8601 date or datetime.

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: CLOSE_LIST_CONTACTSList Close contacts with lead filtering, projection, and offset pagination.

Input Parameters

integer
Number of matching contacts to skip before this page.
integer
Maximum contacts to return in this page, from 1 through 1000.
array
Contact field names to include in each result. Close always returns lead_id.
string
Only return contacts belonging to this lead. This is required when the API key cannot view all leads.

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: CLOSE_LIST_CUSTOM_ACTIVITIESList Close custom activity instances with filters and offset pagination.

Input Parameters

integer
Number of matching custom activities to skip before this page.
integer
Maximum custom activities to return in this page, from 1 through 100.
array
Activity field names to include in each result.
array
Lead IDs whose custom activities to return.
array
Close user IDs whose custom activities to return.
array
Contact IDs whose custom activities to return.
array
Custom activity IDs to include.
string
Include activities occurring strictly after this ISO 8601 date or datetime.
string
Include activities occurring strictly before this ISO 8601 date or datetime.
array
Activity types to include, such as CustomActivity.
string
Include activities occurring at or after this ISO 8601 date or datetime.
string
Include activities occurring at or before this ISO 8601 date or datetime.
string
Include activities created strictly after this ISO 8601 date or datetime.
string
Include activities created strictly before this ISO 8601 date or datetime.
string
Organization ID whose custom activities to return.
string
Include activities created at or after this ISO 8601 date or datetime.
string
Include activities created at or before this ISO 8601 date or datetime.
array
Custom activity type IDs to filter by; requires lead_ids.

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: CLOSE_LIST_CUSTOM_ACTIVITY_TYPESThis tool lists the custom activity types defined in a Close organization, returning each type’s id and name. Use it to find the custom activity type id that filters a custom activity trigger, or before creating a custom activity instance of a given type.

Input Parameters

integer
Number of results to skip for pagination (maps to _skip API parameter). Use together with limit to page through results.
integer
Maximum number of results to return per page (maps to _limit API parameter). Use together with skip to page through results.

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: CLOSE_LIST_CUSTOM_OBJECTSList custom object instances attached to a Close lead, optionally by type.

Input Parameters

integer
Number of matching custom objects to skip before this page.
integer
Maximum custom objects to return in this page.
string
required
ID of the lead whose custom object instances to return.
string
Return only instances of this custom object type.

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: CLOSE_LIST_CUSTOM_OBJECT_TYPESThis tool lists the custom object types defined in a Close organization, returning each type’s id and name. Use it to find the custom object type id that filters a custom activity trigger, or before creating a custom activity instance of a given type.

Input Parameters

integer
Number of results to skip for pagination (maps to _skip API parameter). Use together with limit to page through results.
integer
Maximum number of results to return per page (maps to _limit API parameter). Use together with skip to page through results.

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: CLOSE_LIST_EVENTSList Close change events with filters, projection, and cursor pagination.

Input Parameters

integer
Maximum events to return in this page. Close caps event pages at 50.
string
Filter events by the action that produced them, such as deleted.
string
Opaque cursor from cursor_next or cursor_previous for the page to retrieve.
array
Event field names to include in each result.
string
Filter events by the associated lead ID.
string
Filter events produced by this Close user ID.
string
Filter events for this exact object ID.
string
Filter events emitted while processing this API request ID.
string
Filter events by provider object type, such as activity.sms.
string
Include events updated after this ISO 8601 date or datetime.
string
Include events updated before this ISO 8601 date or datetime.
string
Include events updated at or after this ISO 8601 date or datetime.
string
Include events updated at or before this ISO 8601 date or datetime.

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: CLOSE_LIST_LEADSList or text-search Close leads with field projection and offset pagination.

Input Parameters

integer
Number of matching leads to skip before this page.
integer
Maximum leads to return in this page, from 1 through 200.
string
Text query used by Close to search matching leads.
array
Lead field names to include in each result.

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: CLOSE_LIST_OPPORTUNITIESList a page of Close opportunities with offset pagination. Aggregate values may be included in the response.

Input Parameters

integer
Number of matching opportunities to skip before this page.
integer
Maximum opportunities to return in this page. Close does not publish a resource-specific maximum.
array
Response field names to include for each opportunity.
string
Opportunity status ID to filter by.

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: CLOSE_LIST_TASKSList Close tasks using task, assignee, lead, date, and pagination filters. When task_type is omitted, Close returns only lead tasks; pass all to include every type.

Input Parameters

string
Return tasks at this actionable date or datetime.
integer
Number of matching tasks to skip before this page.
string ("inbox" | "future" | "archive")
Convenience task view. inbox and future override date_gte and date_lt.
integer
Maximum tasks to return in this page, from 1 through 1000.
array
Task field names to include in each result.
string
Provider response format selector.
string
Return tasks actionable strictly after this date or datetime.
string
Return tasks actionable before this ISO 8601 date or datetime.
string
Return only tasks associated with this lead ID.
string
Return the task with this ID.
string
Return tasks actionable at or after this ISO 8601 date or datetime.
string
Return tasks actionable at or before this date or datetime.
string
Deprecated provider due-date equality filter.
string ("date" | "-date" | "date_created" | "-date_created")
Sort by actionable or creation date; prefix ’-’ for descending.
array
Task IDs to include.
string
Provider task type to return, such as lead, outgoing_call, or all. When omitted, Close returns only lead tasks; pass all to include every type.
array
Provider task types to include. Sent as the comma-separated _type__in filter.
string
Return only tasks assigned to this Close user ID.
string
Deprecated due-date lower bound (exclusive).
string
Deprecated due-date upper bound (exclusive).
boolean
Whether to return complete or incomplete tasks.
string
Deprecated due-date lower bound (inclusive).
string
Deprecated due-date upper bound (inclusive).
string
Return tasks created strictly after this date or datetime.
string
Return tasks created before this date or datetime.
string
Return tasks updated strictly after this date or datetime.
string
Return tasks updated before this date or datetime.
string
Organization ID whose tasks should be returned.
string
Return tasks created at or after this date or datetime.
string
Return tasks created at or before this date or datetime.
string
Return tasks updated at or after this date or datetime.
string
Return tasks updated at or before this date or datetime.

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: CLOSE_SEARCH_DATASearch Close objects using the structured Advanced Filtering query language.

Input Parameters

array
Sort definitions containing a provider field object and asc or desc direction. Prefer stable fields such as date_created while paginating.
integer
Maximum matching objects in this page, from 1 through 200.
object
Optional recursive Close query tree. Node type is one of and, or, any_of_saved_search, field_condition, has_related, id, in_status, match_all, object_type, saved_search, or text. Supply the documented fields for that node type; omit query to use the provider default.
string
Cursor returned by the previous search page. Close search cursors expire after 30 seconds.
object
Fields to return by object type, for example {‘lead’: [‘id’, ‘display_name’]}.
integer
Maximum matches available across all pages. Use 0 with include_counts to count matches without returning results.
boolean
Whether to include limited and total match counts.

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: CLOSE_UPDATE_ACTIVITY_CUSTOM_FIELDUpdate mutable settings of one Close activity custom-field definition.

Input Parameters

string
Updated custom-field name.
array
Replacement choices available for the custom field.
string
required
ID of the activity custom-field definition to update.
boolean
Whether the custom field requires a value.
array
Close roles allowed to edit the custom field.
boolean
Whether the custom field accepts multiple values.

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: CLOSE_UPDATE_CUSTOM_ACTIVITYUpdate standard and custom fields on one Close custom activity instance.

Input Parameters

boolean
Whether the activity is pinned; explicit null is preserved.
string ("draft" | "published")
Updated publication status.
string
Updated associated contact ID; explicit null clears it.
string
Updated ISO 8601 activity timestamp; explicit null clears it.
string
required
ID of the custom activity instance to update.
object
Bare custom field IDs mapped to replacement values; null values clear fields.

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: CLOSE_UPDATE_EMAILUpdate an existing Close email activity. Draft edits remain unsent unless status changes. Setting status to scheduled or outbox can deliver the email externally, either later or immediately.

Input Parameters

array
Replacement CC recipients; explicit null clears them.
array
Replacement primary recipients; explicit null clears them.
array
Replacement BCC recipients; explicit null clears them.
array
Replacement email-open records; explicit null clears them.
string
Updated sender address. Required by Close when changing a draft to scheduled or outbox unless the email already has a sender; those statuses can send email externally.
string ("inbox" | "draft" | "scheduled" | "outbox" | "sent" | "error")
Updated email status. Changing a draft to scheduled can send it later, and changing it to outbox can send it externally now.
string
Updated subject; explicit null clears it.
string
Updated associated Close user ID; explicit null clears it.
string
required
ID of the existing Close email activity to update.
string
Updated HTML body; explicit null clears it.
string
Updated plain-text body; explicit null clears it.
string
Updated associated contact ID; explicit null clears it.
string
Updated ISO 8601 activity datetime; explicit null clears it.
array
Replacement list of files previously uploaded to Close; explicit null clears it.
string
Updated Close template ID; explicit null clears it.
string
Updated ISO 8601 follow-up datetime; explicit null clears it.
string
Updated parent email activity ID; explicit null clears it.
string
Updated Close email account ID; explicit null clears it.
string
Updated follow-up sequence ID; explicit null clears it.
integer
Updated follow-up sequence delay in seconds; explicit null clears it.
boolean
Whether CC and BCC recipients should be added to the follow-up sequence; explicit null clears the setting.

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: CLOSE_UPDATE_LEAD_CUSTOM_FIELDUpdate a Close lead custom-field definition. Type changes may convert existing values. Close can return converting_to_type while that conversion runs and omits it after conversion completes.

Input Parameters

string
Updated custom-field name.
string
Updated Close custom-field type. Changing type may convert existing values; converting_to_type can appear in the response while conversion runs.
array
Replacement valid values for a choices-type custom field.
string
Updated custom-field description; explicit null clears it.
string
required
ID of the lead custom-field definition to update.
array
Role IDs allowed to edit field values; an empty list removes role restrictions.
boolean
Whether the custom field accepts multiple values.

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: CLOSE_UPDATE_NOTEUpdate the mutable content and metadata of one Close note activity.

Input Parameters

string
required
ID of the note activity to update.
string
Updated plaintext note; explicit null clears it.
string
Updated note title; explicit null clears it.
boolean
Whether the note is pinned; explicit null clears the value.
string
Updated rich-text HTML; explicit null clears it. Takes precedence over note when both are supplied.
string
Updated associated contact ID; explicit null clears it.
string
Updated ISO 8601 activity datetime; explicit null clears it.
array
Replacement attachment references; explicit null clears them.

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: CLOSE_UPDATE_OPPORTUNITYUpdate standard and custom fields on one Close opportunity.

Input Parameters

string
Updated plain-text or Markdown note.
integer
Updated monetary value in cents.
string
Updated opportunity status label.
string
Updated assigned user ID; explicit null clears it.
string
Updated ISO 8601 won datetime; explicit null clears it.
string
Updated rich-text note; explicit null clears it.
string
Updated opportunity status ID.
integer
Updated confidence percentage.
string
Updated associated contact ID; explicit null clears it.
array
List of uploaded attachment references to include on the opportunity.
string ("one_time" | "monthly" | "annual")
Updated period over which value is paid.
object
Custom field IDs mapped to replacement values; null values clear fields.
string
required
ID of the opportunity to update.
object
Multi-value custom field IDs mapped to one value to add without replacing the existing values.
object
Multi-value custom field IDs mapped to one value to remove without replacing the remaining values.

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: CLOSE_WHO_AM_IReturn the identity (email, name) of the connected Close account.

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

Triggers

Slug: CLOSE_BULK_DELETE_COMPLETEDType: webhookTriggers when a bulk delete finishes.

Payload

object
required
The bulk delete, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_DELETE_CREATEDType: webhookTriggers when a bulk delete is started.

Payload

object
required
The bulk delete, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_DELETE_UPDATEDType: webhookTriggers when a bulk delete makes progress, carrying how many records it has handled so far.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The bulk delete as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EDIT_COMPLETEDType: webhookTriggers when a bulk edit finishes.

Payload

object
required
The bulk edit, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EDIT_CREATEDType: webhookTriggers when a bulk edit is started.

Payload

object
required
The bulk edit, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EDIT_UPDATEDType: webhookTriggers when a bulk edit makes progress, carrying how many records it has handled so far.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The bulk edit as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EMAIL_CREATEDType: webhookTriggers when a bulk email send is started.

Payload

object
required
The bulk email send, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EMAIL_PAUSEDType: webhookTriggers when a bulk email send is paused, either by a person or by Close itself.

Payload

object
required
The bulk email send, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_EMAIL_UPDATEDType: webhookTriggers when a bulk email send makes progress, carrying how many recipients it has handled so far.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The bulk email send as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_SEQUENCE_SUBSCRIPTION_COMPLETEDType: webhookTriggers when a bulk sequence action finishes.

Payload

object
required
The bulk sequence action, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_SEQUENCE_SUBSCRIPTION_CREATEDType: webhookTriggers when a bulk sequence subscribe, pause or resume is started.

Payload

object
required
The bulk sequence action, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_BULK_SEQUENCE_SUBSCRIPTION_UPDATEDType: webhookTriggers when a bulk sequence action makes progress, carrying how many contacts it has handled so far.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The bulk sequence action as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CALL_DELETEDType: webhookTriggers when a call is deleted from a lead’s timeline.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The call as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CALL_LOGGEDType: webhookTriggers when a call is recorded on a lead, whether placed through Close or logged after the fact. Filter on direction for inbound only.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
The call, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CALL_UPDATEDType: webhookTriggers when a recorded call changes, such as its note, outcome, recording or transcript.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The call as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_COMMENT_ADDEDType: webhookTriggers when a comment is posted on an activity or object. The first comment on an object also opens a thread, which fires CLOSE_COMMENT_THREAD_STARTED in the same request.

Payload

object
required
The comment, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CUSTOM_ACTIVITY_DELETEDType: webhookTriggers when a custom activity instance is deleted from a lead.

Configuration

string
Only fire for custom activities of this type, by id, e.g. actitype_abc123. Use CLOSE_LIST_CUSTOM_ACTIVITY_TYPES to find the id. Leave unset to fire for every custom activity type.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The custom activity as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CUSTOM_ACTIVITY_LOGGEDType: webhookTriggers when an instance of a custom activity type is logged on a lead. Filter on custom_activity_type_id for one type only.

Configuration

string
Only fire for custom activities of this type, by id, e.g. actitype_abc123. Use CLOSE_LIST_CUSTOM_ACTIVITY_TYPES to find the id. Leave unset to fire for every custom activity type.

Payload

object
required
The custom activity, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_CUSTOM_ACTIVITY_UPDATEDType: webhookTriggers when an existing custom activity instance changes.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire for custom activities of this type, by id, e.g. actitype_abc123. Use CLOSE_LIST_CUSTOM_ACTIVITY_TYPES to find the id. Leave unset to fire for every custom activity type.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The custom activity as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_DELETEDType: webhookTriggers when an email is deleted from a lead’s timeline.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The email as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_LOGGEDType: webhookTriggers when an email is recorded on a lead, whether it arrived, was drafted, was scheduled, or was logged as already sent. Filter on direction for inbound only.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
The email, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_THREAD_DELETEDType: webhookTriggers when an email thread is deleted from a lead.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The email thread as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_THREAD_STARTEDType: webhookTriggers when a new email thread appears on a lead. The individual messages arrive separately on CLOSE_EMAIL_LOGGED.

Payload

object
required
The email thread, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_THREAD_UPDATEDType: webhookTriggers when an email thread changes, such as a message being added to it or its subject changing.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The email thread as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_EMAIL_UPDATEDType: webhookTriggers when a recorded email changes, such as a draft being edited, an open being recorded, or its status moving.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The email as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_CREATION_ACTIVITY_ADDEDType: webhookTriggers when the ‘Lead Created’ entry is added to a lead’s timeline. This fires alongside CLOSE_LEAD_CREATED for the same lead and adds the timeline position and the import that produced it.

Payload

object
required
The ‘Lead Created’ timeline entry, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_CREATION_ACTIVITY_DELETEDType: webhookTriggers when a ‘Lead Created’ timeline entry is removed, which means its lead was deleted.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The ‘Lead Created’ timeline entry as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_CREATION_ACTIVITY_UPDATEDType: webhookTriggers when a ‘Lead Created’ timeline entry is moved to a different lead, which in practice means its lead was merged into another.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The ‘Lead Created’ timeline entry as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_STATUS_CHANGEDType: webhookTriggers when a lead moves to a different lead status, carrying both the old and the new status. This is the status-change event itself; CLOSE_LEAD_UPDATED also fires for the same move.

Configuration

string
Only fire when the lead lands in this status, by label, e.g. Customer. These are the lead status names shown in the Close sidebar. Leave unset to fire for every status.

Payload

object
required
The lead status change, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_STATUS_CHANGE_ENTRY_DELETEDType: webhookTriggers when a lead-status-change entry is removed from a lead’s timeline.

Configuration

string
Only fire when the lead lands in this status, by label, e.g. Customer. These are the lead status names shown in the Close sidebar. Leave unset to fire for every status.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The lead status change as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_LEAD_STATUS_CHANGE_ENTRY_UPDATEDType: webhookTriggers when Close folds a further status change into an existing lead- status-change timeline entry, which happens when the lead changes status twice in quick succession.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire when the lead lands in this status, by label, e.g. Customer. These are the lead status names shown in the Close sidebar. Leave unset to fire for every status.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The lead status change as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_NOTE_ADDEDType: webhookTriggers when a note is written on a lead.

Payload

object
required
The note, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_NOTE_DELETEDType: webhookTriggers when a note is deleted from a lead.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The note as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_NOTE_UPDATEDType: webhookTriggers when an existing note is edited.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The note as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_OPPORTUNITY_STATUS_CHANGEDType: webhookTriggers when an opportunity moves to a different status, carrying the old and new status, its type (active, won or lost) and the pipeline. Filter on new_status_type for a deal-won automation.

Configuration

string
Only fire when the opportunity lands in this status, by label, e.g. Won. These are the stage names on the pipeline in Close. Leave unset to fire for every status.
string
Only fire when the opportunity lands in a status of this type: active, won or lost. Set it to won for a deal-won automation that survives your team renaming its statuses. Leave unset to fire for all three.
string
Only fire for opportunities in this pipeline, by name, e.g. Sales. This is the pipeline name shown in Close. Leave unset to fire for every pipeline.

Payload

object
required
The opportunity status change, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_DELETEDType: webhookTriggers when an opportunity-status-change entry is removed from a lead’s timeline.

Configuration

string
Only fire when the opportunity lands in this status, by label, e.g. Won. These are the stage names on the pipeline in Close. Leave unset to fire for every status.
string
Only fire when the opportunity lands in a status of this type: active, won or lost. Set it to won for a deal-won automation that survives your team renaming its statuses. Leave unset to fire for all three.
string
Only fire for opportunities in this pipeline, by name, e.g. Sales. This is the pipeline name shown in Close. Leave unset to fire for every pipeline.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The opportunity status change as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_UPDATEDType: webhookTriggers when Close folds a further status change into an existing opportunity-status-change timeline entry.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire when the opportunity lands in this status, by label, e.g. Won. These are the stage names on the pipeline in Close. Leave unset to fire for every status.
string
Only fire when the opportunity lands in a status of this type: active, won or lost. Set it to won for a deal-won automation that survives your team renaming its statuses. Leave unset to fire for all three.
string
Only fire for opportunities in this pipeline, by name, e.g. Sales. This is the pipeline name shown in Close. Leave unset to fire for every pipeline.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The opportunity status change as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_SMS_DELETEDType: webhookTriggers when an SMS is deleted from a lead’s timeline.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The SMS as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_SMS_LOGGEDType: webhookTriggers when an SMS is recorded on a lead. Filter on direction for inbound only.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
The SMS, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_SMS_UPDATEDType: webhookTriggers when a recorded SMS changes, such as its status moving or a delivery error being recorded.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The SMS as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_TASK_COMPLETION_ENTRY_DELETEDType: webhookTriggers when a ‘task completed’ entry is removed from a lead’s timeline.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The task-completed entry as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_TASK_COMPLETION_LOGGEDType: webhookTriggers when a ‘task completed’ entry appears on a lead’s timeline. The task itself also fires its own completion trigger, such as CLOSE_LEAD_TASK_COMPLETED.

Payload

object
required
The task-completed entry, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_WHATSAPP_MESSAGE_DELETEDType: webhookTriggers when a WhatsApp message is deleted from a lead’s timeline.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
What Close recorded about the request that produced this event.
object
required
The WhatsApp message as it last existed, immediately before it was removed.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_WHATSAPP_MESSAGE_LOGGEDType: webhookTriggers when a WhatsApp message is recorded on a lead. Its direction is incoming or outgoing, not the inbound/outbound the other communication triggers use.

Configuration

string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

object
required
The WhatsApp message, as Close delivered it.
object
required
What Close recorded about the request that produced this event.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.
Slug: CLOSE_WHATSAPP_MESSAGE_UPDATEDType: webhookTriggers when a recorded WhatsApp message changes.

Configuration

string
Only fire when this field is one of the fields that changed, e.g. status_id. Close batches every field one request touched into a single delivery and names them in changed_fields, so this is how you narrow an update trigger. Field names are the ones on the object body below. Leave unset to fire on every change.
string
Only fire for this direction. Call and SMS use inbound and outbound; email and WhatsApp use incoming and outgoing. Leave unset to fire for both directions.

Payload

array
required
Names of the object fields this delivery changed. Close batches every field touched by one request into a single updated delivery and lists them here, so this is what an automation branches on to tell a status change from a typo fix.
object
required
The WhatsApp message as it stands after the change.
object
required
What Close recorded about the request that produced this event.
object
required
The prior values of exactly the fields named in changed_fields — a partial object over the same keys as data, not a full copy. A key absent here did not change.
string
Id of the Close request that produced this event. Severaldeliveries share one request_id when a single action emits severalevents — deleting a comment emits comment.updated +comment.deleted + comment_thread.deleted under one request_id, anda lead merge emits lead.merged + lead.deleted under another. It isthe only way to correlate them.
string
Id of the Close user who performed the action. Null when Closeitself acted (auto-created tasks, consolidations, auto-pauses).Distinct from the body’s user_id, which is the user the objectis attributed to.