> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Close

> Close is a CRM platform designed to help businesses manage and streamline their sales processes, including calling, email automation, and predictive dialers.

![Close logo](https://mintcdn.com/composio-preview/NPf8agM6UrvZD-Iu/images/toolkits/close.svg?fit=max\&auto=format\&n=NPf8agM6UrvZD-Iu\&q=85\&s=ed79d0ce8221d8447a08ec6489883728)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 45
* **Slug:** `CLOSE`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Call
>
> **Slug:** `CLOSE_CREATE_CALL`
>
> Creates 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
>
> **note** `string`
>
> A text note about the call
>
> **phone** `string`
>
> The phone number associated with the call
>
> **lead\_id** `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.
>
> **user\_id** `string`
>
> The ID of the user who made/received the call
>
> **duration** `integer`
>
> Duration of the call in seconds
>
> **direction** `string ("outbound" | "inbound")` *required*
>
> The direction of the call (outbound or inbound)
>
> **contact\_id** `string`
>
> The ID of the contact associated with the call
>
> **disposition** `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)
>
> **recording\_url** `string`
>
> HTTPS URL pointing to the MP3 recording of the call
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Email
>
> **Slug:** `CLOSE_CREATE_EMAIL`
>
> Create 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
>
> **cc** `array`
>
> CC recipient email addresses.
>
> **to** `array`
>
> Primary recipient email addresses.
>
> **bcc** `array`
>
> BCC recipient email addresses.
>
> **sender** `string`
>
> Sender address, optionally formatted with a display name. Required for inbox, scheduled, outbox, and error; optional for draft and sent.
>
> **status** `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.
>
> **lead\_id** `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.
>
> **send\_in** `integer`
>
> Seconds to delay an outbox external send, from 0 through 59. Valid only for outbox.
>
> **subject** `string`
>
> Email subject.
>
> **user\_id** `string`
>
> Close user ID associated with the email.
>
> **body\_html** `string`
>
> HTML email body. Omit both body fields when template\_id should be rendered server-side.
>
> **body\_text** `string`
>
> Plain-text email body. Omit both body fields when template\_id should be rendered server-side.
>
> **contact\_id** `string`
>
> Contact ID to associate with the email.
>
> **activity\_at** `string`
>
> ISO 8601 datetime when the email activity occurred.
>
> **attachments** `array`
>
> Files previously uploaded to Close to attach to this email.
>
> **template\_id** `string`
>
> Close email template ID. If both body fields are omitted, Close renders this template server-side.
>
> **date\_created** `string`
>
> ISO 8601 creation datetime when logging an existing email.
>
> **followup\_date** `string`
>
> ISO 8601 datetime for Close to create a follow-up task if no reply is received. Valid only for scheduled, outbox, or sent.
>
> **date\_scheduled** `string`
>
> ISO 8601 send datetime. Required only for scheduled, which causes future external delivery.
>
> **in\_reply\_to\_id** `string`
>
> Email activity ID this message replies to.
>
> **email\_account\_id** `string`
>
> Close email account ID used for the activity or outbound delivery.
>
> **followup\_sequence\_id** `string`
>
> Sequence ID associated with the email follow-up.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Lead
>
> **Slug:** `CLOSE_CREATE_LEAD`
>
> Creates 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
>
> **url** `string`
>
> Website URL of the company
>
> **name** `string` *required*
>
> Name of the company/lead
>
> **contacts** `array`
>
> List of contacts associated with the lead
>
> **addresses** `array`
>
> List of addresses associated with the lead
>
> **status\_id** `string`
>
> ID of the lead status. If not provided, organization's default status will be used
>
> **description** `string`
>
> Description of the lead
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Opportunity
>
> **Slug:** `CLOSE_CREATE_OPPORTUNITY`
>
> Create a Close sales opportunity on an existing lead, or create an Untitled lead for it when lead\_id is omitted.
>
> #### Input Parameters
>
> **note** `string`
>
> Plain-text or Markdown note.
>
> **value** `integer`
>
> Monetary opportunity value in cents.
>
> **lead\_id** `string`
>
> ID of an existing lead; omit it to let Close create an Untitled lead.
>
> **user\_id** `string`
>
> ID of the Close user assigned to the opportunity.
>
> **date\_won** `string`
>
> ISO 8601 won timestamp; Close may set it from a won status.
>
> **note\_html** `string`
>
> Rich-text HTML note.
>
> **status\_id** `string`
>
> Initial opportunity status ID.
>
> **confidence** `integer`
>
> Opportunity confidence percentage.
>
> **contact\_id** `string`
>
> ID of the contact associated with the opportunity.
>
> **created\_by** `string`
>
> ID of the Close user recorded as the creator.
>
> **attachments** `array`
>
> Uploaded attachment references to include.
>
> **pipeline\_id** `string`
>
> Pipeline ID used to select the default or specified status.
>
> **date\_created** `string`
>
> ISO 8601 opportunity creation timestamp.
>
> **value\_period** `string ("one_time" | "monthly" | "annual")`
>
> Period over which the opportunity value applies.
>
> **custom\_fields** `object`
>
> Bare custom field IDs mapped to values for the opportunity.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create SMS Message
>
> **Slug:** `CLOSE_CREATE_SMS`
>
> Create 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
>
> **text** `string` *required*
>
> The content of the SMS message
>
> **status** `string ("inbox" | "draft" | "scheduled" | "outbox" | "sent")` *required*
>
> The status of the SMS. Must be one of: inbox, draft, scheduled, outbox, sent
>
> **lead\_id** `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.
>
> **send\_in** `integer`
>
> Number of seconds to delay sending the SMS when status is outbox. Must be less than 60
>
> **direction** `string ("inbound" | "outbound")`
>
> The direction of the SMS. Defaults to 'inbound' if status is inbox, otherwise 'outbound'
>
> **contact\_id** `string`
>
> The ID of the contact associated with the SMS
>
> **local\_phone** `string` *required*
>
> The internal phone number used to send the SMS. Must be associated with a Phone Number of type 'internal'
>
> **template\_id** `string`
>
> The ID of an SMS Template to render and use as the message content
>
> **remote\_phone** `string` *required*
>
> The recipient's phone number
>
> **date\_scheduled** `string`
>
> The date and time when the SMS should be sent (required if status is 'scheduled')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Task
>
> **Slug:** `CLOSE_CREATE_TASK`
>
> Create a Close task associated with a lead, using task text and an actionable date, with optional completion status and assignment.
>
> #### Input Parameters
>
> **date** `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)
>
> **text** `string` *required*
>
> Description of the task
>
> **\_type** `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'
>
> **lead\_id** `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.
>
> **assigned\_to** `string`
>
> User ID of the person the task is assigned to. If omitted, assigns to the API caller
>
> **is\_complete** `boolean`
>
> Whether the task is complete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Activity Custom Field
>
> **Slug:** `CLOSE_DELETE_ACTIVITY_CUSTOM_FIELD`
>
> Permanently delete one Close activity custom-field definition by ID.
>
> #### Input Parameters
>
> **field\_id** `string` *required*
>
> The unique identifier of the activity custom-field definition to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Call
>
> **Slug:** `CLOSE_DELETE_CALL`
>
> This 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
>
> **call\_id** `string` *required*
>
> The unique identifier of the call activity to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Activity
>
> **Slug:** `CLOSE_DELETE_CUSTOM_ACTIVITY`
>
> Permanently delete one Close custom activity instance by ID.
>
> #### Input Parameters
>
> **activity\_id** `string` *required*
>
> The unique identifier of the custom activity instance to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email
>
> **Slug:** `CLOSE_DELETE_EMAIL`
>
> This 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
>
> **email\_id** `string` *required*
>
> The unique identifier of the email activity to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Lead
>
> **Slug:** `CLOSE_DELETE_LEAD`
>
> Permanently delete one Close lead by ID.
>
> #### Input Parameters
>
> **lead\_id** `string` *required*
>
> The unique identifier of the lead to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Lead Custom Field
>
> **Slug:** `CLOSE_DELETE_LEAD_CUSTOM_FIELD`
>
> Permanently delete a Close lead custom-field definition and its values.
>
> #### Input Parameters
>
> **custom\_field\_id** `string` *required*
>
> ID of the lead custom-field definition to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Note
>
> **Slug:** `CLOSE_DELETE_NOTE`
>
> Permanently delete one Close note activity by ID.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> The unique identifier of the note activity to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Opportunity
>
> **Slug:** `CLOSE_DELETE_OPPORTUNITY`
>
> Permanently delete one Close opportunity by ID.
>
> #### Input Parameters
>
> **opportunity\_id** `string` *required*
>
> The unique identifier of the opportunity to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Call
>
> **Slug:** `CLOSE_GET_CALL`
>
> Retrieve one Close call activity by ID with optional field projection.
>
> #### Input Parameters
>
> **fields** `array`
>
> Call field names to include in the response.
>
> **call\_id** `string` *required*
>
> ID of the call activity to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact
>
> **Slug:** `CLOSE_GET_CONTACT`
>
> Retrieve one Close contact by ID, optionally limiting returned fields.
>
> #### Input Parameters
>
> **fields** `array`
>
> Response field names to include. Omit to return the provider's default contact fields.
>
> **contact\_id** `string` *required*
>
> ID of the contact to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email
>
> **Slug:** `CLOSE_GET_EMAIL`
>
> Retrieve one Close email activity by ID with optional field projection.
>
> #### Input Parameters
>
> **fields** `array`
>
> Email field names to include in the response.
>
> **email\_id** `string` *required*
>
> ID of the email activity to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lead
>
> **Slug:** `CLOSE_GET_LEAD`
>
> Retrieve one Close lead by ID with optional field projection.
>
> #### Input Parameters
>
> **fields** `array`
>
> Response field names to include.
>
> **lead\_id** `string` *required*
>
> ID of the lead to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notes
>
> **Slug:** `CLOSE_GET_NOTE`
>
> This 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
>
> **skip** `integer`
>
> Number of results to skip for pagination (maps to \_skip API parameter). Use together with limit to page through results.
>
> **limit** `integer`
>
> Maximum number of results to return per page (maps to \_limit API parameter). Use together with skip to page through results.
>
> **lead\_id** `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.
>
> **user\_id** `string`
>
> Filter notes by a specific user ID
>
> **date\_created\_\_gt** `string`
>
> Filter notes created after this date (ISO 8601 format)
>
> **date\_created\_\_lt** `string`
>
> Filter notes created before this date (ISO 8601 format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Opportunity
>
> **Slug:** `CLOSE_GET_OPPORTUNITY`
>
> Retrieve one Close opportunity by ID with optional field projection.
>
> #### Input Parameters
>
> **fields** `array`
>
> Response field names to include.
>
> **opportunity\_id** `string` *required*
>
> ID of the opportunity to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS
>
> **Slug:** `CLOSE_GET_SMS`
>
> Retrieve one Close SMS activity by ID with optional field projection.
>
> #### Input Parameters
>
> **fields** `array`
>
> SMS field names to include in the response.
>
> **sms\_id** `string` *required*
>
> ID of the SMS activity to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Activities
>
> **Slug:** `CLOSE_LIST_ACTIVITIES`
>
> Lists one page of Close email or call activities using documented filters.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching activities to skip before this page.
>
> **limit** `integer`
>
> Maximum activities to return in this page. Close does not publish a subtype-specific maximum.
>
> **fields** `array`
>
> Response field names to include. Use projection to reduce large activity payloads.
>
> **lead\_ids** `array`
>
> Lead IDs whose activities should be returned.
>
> **order\_by** `string ("date_created" | "-date_created" | "activity_at" | "-activity_at")`
>
> Sort field, optionally descending with '-'. Activity-at ordering requires exactly one lead ID.
>
> **user\_ids** `array`
>
> Close user IDs whose activities should be returned.
>
> **contact\_ids** `array`
>
> Contact IDs whose activities should be returned.
>
> **activity\_ids** `array`
>
> Activity IDs to include.
>
> **activity\_type** `string ("email" | "call")` *required*
>
> Activity subtype to return; selects the email or call endpoint.
>
> **activity\_at\_gt** `string`
>
> Include activities that occurred strictly after this ISO 8601 date or datetime; requires order\_by=-activity\_at and exactly one lead ID.
>
> **activity\_at\_lt** `string`
>
> Include activities that occurred strictly before this ISO 8601 date or datetime; requires order\_by=-activity\_at and exactly one lead ID.
>
> **activity\_at\_gte** `string`
>
> Include activities that occurred at or after this ISO 8601 date or datetime; requires order\_by=-activity\_at and exactly one lead ID.
>
> **activity\_at\_lte** `string`
>
> Include activities that occurred at or before this ISO 8601 date or datetime; requires order\_by=-activity\_at and exactly one lead ID.
>
> **date\_created\_gt** `string`
>
> Include activities created strictly after this ISO 8601 date or datetime.
>
> **date\_created\_lt** `string`
>
> Include activities created strictly before this ISO 8601 date or datetime.
>
> **organization\_id** `string`
>
> Organization ID to filter activities by.
>
> **date\_created\_gte** `string`
>
> Include activities created at or after this ISO 8601 date or datetime.
>
> **date\_created\_lte** `string`
>
> Include activities created at or before this ISO 8601 date or datetime.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contacts
>
> **Slug:** `CLOSE_LIST_CONTACTS`
>
> List Close contacts with lead filtering, projection, and offset pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching contacts to skip before this page.
>
> **limit** `integer`
>
> Maximum contacts to return in this page, from 1 through 1000.
>
> **fields** `array`
>
> Contact field names to include in each result. Close always returns lead\_id.
>
> **lead\_id** `string`
>
> Only return contacts belonging to this lead. This is required when the API key cannot view all leads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Activities
>
> **Slug:** `CLOSE_LIST_CUSTOM_ACTIVITIES`
>
> List Close custom activity instances with filters and offset pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching custom activities to skip before this page.
>
> **limit** `integer`
>
> Maximum custom activities to return in this page, from 1 through 100.
>
> **fields** `array`
>
> Activity field names to include in each result.
>
> **lead\_ids** `array`
>
> Lead IDs whose custom activities to return.
>
> **user\_ids** `array`
>
> Close user IDs whose custom activities to return.
>
> **contact\_ids** `array`
>
> Contact IDs whose custom activities to return.
>
> **activity\_ids** `array`
>
> Custom activity IDs to include.
>
> **activity\_at\_gt** `string`
>
> Include activities occurring strictly after this ISO 8601 date or datetime.
>
> **activity\_at\_lt** `string`
>
> Include activities occurring strictly before this ISO 8601 date or datetime.
>
> **activity\_types** `array`
>
> Activity types to include, such as CustomActivity.
>
> **activity\_at\_gte** `string`
>
> Include activities occurring at or after this ISO 8601 date or datetime.
>
> **activity\_at\_lte** `string`
>
> Include activities occurring at or before this ISO 8601 date or datetime.
>
> **date\_created\_gt** `string`
>
> Include activities created strictly after this ISO 8601 date or datetime.
>
> **date\_created\_lt** `string`
>
> Include activities created strictly before this ISO 8601 date or datetime.
>
> **organization\_id** `string`
>
> Organization ID whose custom activities to return.
>
> **date\_created\_gte** `string`
>
> Include activities created at or after this ISO 8601 date or datetime.
>
> **date\_created\_lte** `string`
>
> Include activities created at or before this ISO 8601 date or datetime.
>
> **custom\_activity\_type\_ids** `array`
>
> Custom activity type IDs to filter by; requires lead\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Activity Types
>
> **Slug:** `CLOSE_LIST_CUSTOM_ACTIVITY_TYPES`
>
> This 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
>
> **skip** `integer`
>
> Number of results to skip for pagination (maps to \_skip API parameter). Use together with limit to page through results.
>
> **limit** `integer`
>
> Maximum number of results to return per page (maps to \_limit API parameter). Use together with skip to page through results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Objects
>
> **Slug:** `CLOSE_LIST_CUSTOM_OBJECTS`
>
> List custom object instances attached to a Close lead, optionally by type.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching custom objects to skip before this page.
>
> **limit** `integer`
>
> Maximum custom objects to return in this page.
>
> **lead\_id** `string` *required*
>
> ID of the lead whose custom object instances to return.
>
> **custom\_object\_type\_id** `string`
>
> Return only instances of this custom object type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Types
>
> **Slug:** `CLOSE_LIST_CUSTOM_OBJECT_TYPES`
>
> This 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
>
> **skip** `integer`
>
> Number of results to skip for pagination (maps to \_skip API parameter). Use together with limit to page through results.
>
> **limit** `integer`
>
> Maximum number of results to return per page (maps to \_limit API parameter). Use together with skip to page through results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Events
>
> **Slug:** `CLOSE_LIST_EVENTS`
>
> List Close change events with filters, projection, and cursor pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum events to return in this page. Close caps event pages at 50.
>
> **action** `string`
>
> Filter events by the action that produced them, such as deleted.
>
> **cursor** `string`
>
> Opaque cursor from cursor\_next or cursor\_previous for the page to retrieve.
>
> **fields** `array`
>
> Event field names to include in each result.
>
> **lead\_id** `string`
>
> Filter events by the associated lead ID.
>
> **user\_id** `string`
>
> Filter events produced by this Close user ID.
>
> **object\_id** `string`
>
> Filter events for this exact object ID.
>
> **request\_id** `string`
>
> Filter events emitted while processing this API request ID.
>
> **object\_type** `string`
>
> Filter events by provider object type, such as activity.sms.
>
> **date\_updated\_gt** `string`
>
> Include events updated after this ISO 8601 date or datetime.
>
> **date\_updated\_lt** `string`
>
> Include events updated before this ISO 8601 date or datetime.
>
> **date\_updated\_gte** `string`
>
> Include events updated at or after this ISO 8601 date or datetime.
>
> **date\_updated\_lte** `string`
>
> Include events updated at or before this ISO 8601 date or datetime.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Leads
>
> **Slug:** `CLOSE_LIST_LEADS`
>
> List or text-search Close leads with field projection and offset pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching leads to skip before this page.
>
> **limit** `integer`
>
> Maximum leads to return in this page, from 1 through 200.
>
> **query** `string`
>
> Text query used by Close to search matching leads.
>
> **fields** `array`
>
> Lead field names to include in each result.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Opportunities
>
> **Slug:** `CLOSE_LIST_OPPORTUNITIES`
>
> List a page of Close opportunities with offset pagination. Aggregate values may be included in the response.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of matching opportunities to skip before this page.
>
> **limit** `integer`
>
> Maximum opportunities to return in this page. Close does not publish a resource-specific maximum.
>
> **fields** `array`
>
> Response field names to include for each opportunity.
>
> **status\_id** `string`
>
> Opportunity status ID to filter by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tasks
>
> **Slug:** `CLOSE_LIST_TASKS`
>
> List 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
>
> **date** `string`
>
> Return tasks at this actionable date or datetime.
>
> **skip** `integer`
>
> Number of matching tasks to skip before this page.
>
> **view** `string ("inbox" | "future" | "archive")`
>
> Convenience task view. inbox and future override date\_gte and date\_lt.
>
> **limit** `integer`
>
> Maximum tasks to return in this page, from 1 through 1000.
>
> **fields** `array`
>
> Task field names to include in each result.
>
> **format** `string`
>
> Provider response format selector.
>
> **date\_gt** `string`
>
> Return tasks actionable strictly after this date or datetime.
>
> **date\_lt** `string`
>
> Return tasks actionable before this ISO 8601 date or datetime.
>
> **lead\_id** `string`
>
> Return only tasks associated with this lead ID.
>
> **task\_id** `string`
>
> Return the task with this ID.
>
> **date\_gte** `string`
>
> Return tasks actionable at or after this ISO 8601 date or datetime.
>
> **date\_lte** `string`
>
> Return tasks actionable at or before this date or datetime.
>
> **due\_date** `string`
>
> Deprecated provider due-date equality filter.
>
> **order\_by** `string ("date" | "-date" | "date_created" | "-date_created")`
>
> Sort by actionable or creation date; prefix '-' for descending.
>
> **task\_ids** `array`
>
> Task IDs to include.
>
> **task\_type** `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.
>
> **task\_types** `array`
>
> Provider task types to include. Sent as the comma-separated \_type\_\_in filter.
>
> **assigned\_to** `string`
>
> Return only tasks assigned to this Close user ID.
>
> **due\_date\_gt** `string`
>
> Deprecated due-date lower bound (exclusive).
>
> **due\_date\_lt** `string`
>
> Deprecated due-date upper bound (exclusive).
>
> **is\_complete** `boolean`
>
> Whether to return complete or incomplete tasks.
>
> **due\_date\_gte** `string`
>
> Deprecated due-date lower bound (inclusive).
>
> **due\_date\_lte** `string`
>
> Deprecated due-date upper bound (inclusive).
>
> **date\_created\_gt** `string`
>
> Return tasks created strictly after this date or datetime.
>
> **date\_created\_lt** `string`
>
> Return tasks created before this date or datetime.
>
> **date\_updated\_gt** `string`
>
> Return tasks updated strictly after this date or datetime.
>
> **date\_updated\_lt** `string`
>
> Return tasks updated before this date or datetime.
>
> **organization\_id** `string`
>
> Organization ID whose tasks should be returned.
>
> **date\_created\_gte** `string`
>
> Return tasks created at or after this date or datetime.
>
> **date\_created\_lte** `string`
>
> Return tasks created at or before this date or datetime.
>
> **date\_updated\_gte** `string`
>
> Return tasks updated at or after this date or datetime.
>
> **date\_updated\_lte** `string`
>
> Return tasks updated at or before this date or datetime.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Data
>
> **Slug:** `CLOSE_SEARCH_DATA`
>
> Search Close objects using the structured Advanced Filtering query language.
>
> #### Input Parameters
>
> **sort** `array`
>
> Sort definitions containing a provider field object and asc or desc direction. Prefer stable fields such as date\_created while paginating.
>
> **limit** `integer`
>
> Maximum matching objects in this page, from 1 through 200.
>
> **query** `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.
>
> **cursor** `string`
>
> Cursor returned by the previous search page. Close search cursors expire after 30 seconds.
>
> **fields** `object`
>
> Fields to return by object type, for example \{'lead': \['id', 'display\_name']}.
>
> **results\_limit** `integer`
>
> Maximum matches available across all pages. Use 0 with include\_counts to count matches without returning results.
>
> **include\_counts** `boolean`
>
> Whether to include limited and total match counts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Activity Custom Field
>
> **Slug:** `CLOSE_UPDATE_ACTIVITY_CUSTOM_FIELD`
>
> Update mutable settings of one Close activity custom-field definition.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated custom-field name.
>
> **choices** `array`
>
> Replacement choices available for the custom field.
>
> **field\_id** `string` *required*
>
> ID of the activity custom-field definition to update.
>
> **required** `boolean`
>
> Whether the custom field requires a value.
>
> **editable\_with\_roles** `array`
>
> Close roles allowed to edit the custom field.
>
> **accepts\_multiple\_values** `boolean`
>
> Whether the custom field accepts multiple values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Activity
>
> **Slug:** `CLOSE_UPDATE_CUSTOM_ACTIVITY`
>
> Update standard and custom fields on one Close custom activity instance.
>
> #### Input Parameters
>
> **pinned** `boolean`
>
> Whether the activity is pinned; explicit null is preserved.
>
> **status** `string ("draft" | "published")`
>
> Updated publication status.
>
> **contact\_id** `string`
>
> Updated associated contact ID; explicit null clears it.
>
> **activity\_at** `string`
>
> Updated ISO 8601 activity timestamp; explicit null clears it.
>
> **activity\_id** `string` *required*
>
> ID of the custom activity instance to update.
>
> **custom\_fields** `object`
>
> Bare custom field IDs mapped to replacement values; null values clear fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Email
>
> **Slug:** `CLOSE_UPDATE_EMAIL`
>
> Update 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
>
> **cc** `array`
>
> Replacement CC recipients; explicit null clears them.
>
> **to** `array`
>
> Replacement primary recipients; explicit null clears them.
>
> **bcc** `array`
>
> Replacement BCC recipients; explicit null clears them.
>
> **opens** `array`
>
> Replacement email-open records; explicit null clears them.
>
> **sender** `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.
>
> **status** `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.
>
> **subject** `string`
>
> Updated subject; explicit null clears it.
>
> **user\_id** `string`
>
> Updated associated Close user ID; explicit null clears it.
>
> **email\_id** `string` *required*
>
> ID of the existing Close email activity to update.
>
> **body\_html** `string`
>
> Updated HTML body; explicit null clears it.
>
> **body\_text** `string`
>
> Updated plain-text body; explicit null clears it.
>
> **contact\_id** `string`
>
> Updated associated contact ID; explicit null clears it.
>
> **activity\_at** `string`
>
> Updated ISO 8601 activity datetime; explicit null clears it.
>
> **attachments** `array`
>
> Replacement list of files previously uploaded to Close; explicit null clears it.
>
> **template\_id** `string`
>
> Updated Close template ID; explicit null clears it.
>
> **followup\_date** `string`
>
> Updated ISO 8601 follow-up datetime; explicit null clears it.
>
> **in\_reply\_to\_id** `string`
>
> Updated parent email activity ID; explicit null clears it.
>
> **email\_account\_id** `string`
>
> Updated Close email account ID; explicit null clears it.
>
> **followup\_sequence\_id** `string`
>
> Updated follow-up sequence ID; explicit null clears it.
>
> **followup\_sequence\_delay** `integer`
>
> Updated follow-up sequence delay in seconds; explicit null clears it.
>
> **followup\_sequence\_add\_cc\_bcc** `boolean`
>
> Whether CC and BCC recipients should be added to the follow-up sequence; explicit null clears the setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Lead Custom Field
>
> **Slug:** `CLOSE_UPDATE_LEAD_CUSTOM_FIELD`
>
> Update 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
>
> **name** `string`
>
> Updated custom-field name.
>
> **type** `string`
>
> Updated Close custom-field type. Changing type may convert existing values; converting\_to\_type can appear in the response while conversion runs.
>
> **choices** `array`
>
> Replacement valid values for a choices-type custom field.
>
> **description** `string`
>
> Updated custom-field description; explicit null clears it.
>
> **custom\_field\_id** `string` *required*
>
> ID of the lead custom-field definition to update.
>
> **editable\_with\_roles** `array`
>
> Role IDs allowed to edit field values; an empty list removes role restrictions.
>
> **accepts\_multiple\_values** `boolean`
>
> Whether the custom field accepts multiple values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Note
>
> **Slug:** `CLOSE_UPDATE_NOTE`
>
> Update the mutable content and metadata of one Close note activity.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the note activity to update.
>
> **note** `string`
>
> Updated plaintext note; explicit null clears it.
>
> **title** `string`
>
> Updated note title; explicit null clears it.
>
> **pinned** `boolean`
>
> Whether the note is pinned; explicit null clears the value.
>
> **note\_html** `string`
>
> Updated rich-text HTML; explicit null clears it. Takes precedence over note when both are supplied.
>
> **contact\_id** `string`
>
> Updated associated contact ID; explicit null clears it.
>
> **activity\_at** `string`
>
> Updated ISO 8601 activity datetime; explicit null clears it.
>
> **attachments** `array`
>
> Replacement attachment references; explicit null clears them.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Opportunity
>
> **Slug:** `CLOSE_UPDATE_OPPORTUNITY`
>
> Update standard and custom fields on one Close opportunity.
>
> #### Input Parameters
>
> **note** `string`
>
> Updated plain-text or Markdown note.
>
> **value** `integer`
>
> Updated monetary value in cents.
>
> **status** `string`
>
> Updated opportunity status label.
>
> **user\_id** `string`
>
> Updated assigned user ID; explicit null clears it.
>
> **date\_won** `string`
>
> Updated ISO 8601 won datetime; explicit null clears it.
>
> **note\_html** `string`
>
> Updated rich-text note; explicit null clears it.
>
> **status\_id** `string`
>
> Updated opportunity status ID.
>
> **confidence** `integer`
>
> Updated confidence percentage.
>
> **contact\_id** `string`
>
> Updated associated contact ID; explicit null clears it.
>
> **attachments** `array`
>
> List of uploaded attachment references to include on the opportunity.
>
> **value\_period** `string ("one_time" | "monthly" | "annual")`
>
> Updated period over which value is paid.
>
> **custom\_fields** `object`
>
> Custom field IDs mapped to replacement values; null values clear fields.
>
> **opportunity\_id** `string` *required*
>
> ID of the opportunity to update.
>
> **custom\_fields\_add** `object`
>
> Multi-value custom field IDs mapped to one value to add without replacing the existing values.
>
> **custom\_fields\_remove** `object`
>
> Multi-value custom field IDs mapped to one value to remove without replacing the remaining values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Who Am I
>
> **Slug:** `CLOSE_WHO_AM_I`
>
> Return the identity (email, name) of the connected Close account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

## Triggers

> [accordion] Bulk Delete Completed
>
> **Slug:** `CLOSE_BULK_DELETE_COMPLETED`
>
> **Type:** webhook
>
> Triggers when a bulk delete finishes.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk delete, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Delete Created
>
> **Slug:** `CLOSE_BULK_DELETE_CREATED`
>
> **Type:** webhook
>
> Triggers when a bulk delete is started.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk delete, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Delete Updated
>
> **Slug:** `CLOSE_BULK_DELETE_UPDATED`
>
> **Type:** webhook
>
> Triggers when a bulk delete makes progress, carrying how many records it has handled so far.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The bulk delete as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Edit Completed
>
> **Slug:** `CLOSE_BULK_EDIT_COMPLETED`
>
> **Type:** webhook
>
> Triggers when a bulk edit finishes.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk edit, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Edit Created
>
> **Slug:** `CLOSE_BULK_EDIT_CREATED`
>
> **Type:** webhook
>
> Triggers when a bulk edit is started.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk edit, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Edit Updated
>
> **Slug:** `CLOSE_BULK_EDIT_UPDATED`
>
> **Type:** webhook
>
> Triggers when a bulk edit makes progress, carrying how many records it has handled so far.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The bulk edit as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Email Created
>
> **Slug:** `CLOSE_BULK_EMAIL_CREATED`
>
> **Type:** webhook
>
> Triggers when a bulk email send is started.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk email send, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Email Paused
>
> **Slug:** `CLOSE_BULK_EMAIL_PAUSED`
>
> **Type:** webhook
>
> Triggers when a bulk email send is paused, either by a person or by Close itself.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk email send, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Email Updated
>
> **Slug:** `CLOSE_BULK_EMAIL_UPDATED`
>
> **Type:** webhook
>
> Triggers when a bulk email send makes progress, carrying how many recipients it has handled so far.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The bulk email send as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Sequence Subscription Completed
>
> **Slug:** `CLOSE_BULK_SEQUENCE_SUBSCRIPTION_COMPLETED`
>
> **Type:** webhook
>
> Triggers when a bulk sequence action finishes.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk sequence action, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Sequence Subscription Created
>
> **Slug:** `CLOSE_BULK_SEQUENCE_SUBSCRIPTION_CREATED`
>
> **Type:** webhook
>
> Triggers when a bulk sequence subscribe, pause or resume is started.
>
> #### Payload
>
> **data** `object` *required*
>
> The bulk sequence action, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Bulk Sequence Subscription Updated
>
> **Slug:** `CLOSE_BULK_SEQUENCE_SUBSCRIPTION_UPDATED`
>
> **Type:** webhook
>
> Triggers when a bulk sequence action makes progress, carrying how many contacts it has handled so far.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The bulk sequence action as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Call Deleted
>
> **Slug:** `CLOSE_CALL_DELETED`
>
> **Type:** webhook
>
> Triggers when a call is deleted from a lead's timeline.
>
> #### Configuration
>
> **direction** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The call as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Call Logged
>
> **Slug:** `CLOSE_CALL_LOGGED`
>
> **Type:** webhook
>
> Triggers when a call is recorded on a lead, whether placed through Close or logged after the fact. Filter on `direction` for inbound only.
>
> #### Configuration
>
> **direction** `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
>
> **data** `object` *required*
>
> The call, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Call Updated
>
> **Slug:** `CLOSE_CALL_UPDATED`
>
> **Type:** webhook
>
> Triggers when a recorded call changes, such as its note, outcome, recording or transcript.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **direction** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The call as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Comment Added
>
> **Slug:** `CLOSE_COMMENT_ADDED`
>
> **Type:** webhook
>
> Triggers 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
>
> **data** `object` *required*
>
> The comment, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Custom Activity Deleted
>
> **Slug:** `CLOSE_CUSTOM_ACTIVITY_DELETED`
>
> **Type:** webhook
>
> Triggers when a custom activity instance is deleted from a lead.
>
> #### Configuration
>
> **custom\_activity\_type\_id** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The custom activity as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Custom Activity Logged
>
> **Slug:** `CLOSE_CUSTOM_ACTIVITY_LOGGED`
>
> **Type:** webhook
>
> Triggers when an instance of a custom activity type is logged on a lead. Filter on `custom_activity_type_id` for one type only.
>
> #### Configuration
>
> **custom\_activity\_type\_id** `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
>
> **data** `object` *required*
>
> The custom activity, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Custom Activity Updated
>
> **Slug:** `CLOSE_CUSTOM_ACTIVITY_UPDATED`
>
> **Type:** webhook
>
> Triggers when an existing custom activity instance changes.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **custom\_activity\_type\_id** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The custom activity as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Deleted
>
> **Slug:** `CLOSE_EMAIL_DELETED`
>
> **Type:** webhook
>
> Triggers when an email is deleted from a lead's timeline.
>
> #### Configuration
>
> **direction** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The email as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Logged
>
> **Slug:** `CLOSE_EMAIL_LOGGED`
>
> **Type:** webhook
>
> Triggers 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
>
> **direction** `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
>
> **data** `object` *required*
>
> The email, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Thread Deleted
>
> **Slug:** `CLOSE_EMAIL_THREAD_DELETED`
>
> **Type:** webhook
>
> Triggers when an email thread is deleted from a lead.
>
> #### Payload
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The email thread as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Thread Started
>
> **Slug:** `CLOSE_EMAIL_THREAD_STARTED`
>
> **Type:** webhook
>
> Triggers when a new email thread appears on a lead. The individual messages arrive separately on CLOSE\_EMAIL\_LOGGED.
>
> #### Payload
>
> **data** `object` *required*
>
> The email thread, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Thread Updated
>
> **Slug:** `CLOSE_EMAIL_THREAD_UPDATED`
>
> **Type:** webhook
>
> Triggers when an email thread changes, such as a message being added to it or its subject changing.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The email thread as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Email Updated
>
> **Slug:** `CLOSE_EMAIL_UPDATED`
>
> **Type:** webhook
>
> Triggers when a recorded email changes, such as a draft being edited, an open being recorded, or its status moving.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **direction** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The email as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Creation Activity Added
>
> **Slug:** `CLOSE_LEAD_CREATION_ACTIVITY_ADDED`
>
> **Type:** webhook
>
> Triggers 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
>
> **data** `object` *required*
>
> The 'Lead Created' timeline entry, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Creation Activity Deleted
>
> **Slug:** `CLOSE_LEAD_CREATION_ACTIVITY_DELETED`
>
> **Type:** webhook
>
> Triggers when a 'Lead Created' timeline entry is removed, which means its lead was deleted.
>
> #### Payload
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The 'Lead Created' timeline entry as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Creation Activity Updated
>
> **Slug:** `CLOSE_LEAD_CREATION_ACTIVITY_UPDATED`
>
> **Type:** webhook
>
> Triggers when a 'Lead Created' timeline entry is moved to a different lead, which in practice means its lead was merged into another.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The 'Lead Created' timeline entry as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Status Changed
>
> **Slug:** `CLOSE_LEAD_STATUS_CHANGED`
>
> **Type:** webhook
>
> Triggers 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
>
> **new\_status** `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
>
> **data** `object` *required*
>
> The lead status change, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Status Change Entry Deleted
>
> **Slug:** `CLOSE_LEAD_STATUS_CHANGE_ENTRY_DELETED`
>
> **Type:** webhook
>
> Triggers when a lead-status-change entry is removed from a lead's timeline.
>
> #### Configuration
>
> **new\_status** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The lead status change as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Lead Status Change Entry Updated
>
> **Slug:** `CLOSE_LEAD_STATUS_CHANGE_ENTRY_UPDATED`
>
> **Type:** webhook
>
> Triggers 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
>
> **changed\_field** `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.
>
> **new\_status** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The lead status change as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Note Added
>
> **Slug:** `CLOSE_NOTE_ADDED`
>
> **Type:** webhook
>
> Triggers when a note is written on a lead.
>
> #### Payload
>
> **data** `object` *required*
>
> The note, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Note Deleted
>
> **Slug:** `CLOSE_NOTE_DELETED`
>
> **Type:** webhook
>
> Triggers when a note is deleted from a lead.
>
> #### Payload
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The note as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Note Updated
>
> **Slug:** `CLOSE_NOTE_UPDATED`
>
> **Type:** webhook
>
> Triggers when an existing note is edited.
>
> #### Configuration
>
> **changed\_field** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The note as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Opportunity Status Changed
>
> **Slug:** `CLOSE_OPPORTUNITY_STATUS_CHANGED`
>
> **Type:** webhook
>
> Triggers 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
>
> **new\_status** `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.
>
> **new\_status\_type** `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.
>
> **pipeline** `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
>
> **data** `object` *required*
>
> The opportunity status change, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Opportunity Status Change Entry Deleted
>
> **Slug:** `CLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_DELETED`
>
> **Type:** webhook
>
> Triggers when an opportunity-status-change entry is removed from a lead's timeline.
>
> #### Configuration
>
> **new\_status** `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.
>
> **new\_status\_type** `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.
>
> **pipeline** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The opportunity status change as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Opportunity Status Change Entry Updated
>
> **Slug:** `CLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_UPDATED`
>
> **Type:** webhook
>
> Triggers when Close folds a further status change into an existing opportunity-status-change timeline entry.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **new\_status** `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.
>
> **new\_status\_type** `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.
>
> **pipeline** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The opportunity status change as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] SMS Deleted
>
> **Slug:** `CLOSE_SMS_DELETED`
>
> **Type:** webhook
>
> Triggers when an SMS is deleted from a lead's timeline.
>
> #### Configuration
>
> **direction** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The SMS as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] SMS Logged
>
> **Slug:** `CLOSE_SMS_LOGGED`
>
> **Type:** webhook
>
> Triggers when an SMS is recorded on a lead. Filter on `direction` for inbound only.
>
> #### Configuration
>
> **direction** `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
>
> **data** `object` *required*
>
> The SMS, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] SMS Updated
>
> **Slug:** `CLOSE_SMS_UPDATED`
>
> **Type:** webhook
>
> Triggers when a recorded SMS changes, such as its status moving or a delivery error being recorded.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **direction** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The SMS as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Task Completion Entry Deleted
>
> **Slug:** `CLOSE_TASK_COMPLETION_ENTRY_DELETED`
>
> **Type:** webhook
>
> Triggers when a 'task completed' entry is removed from a lead's timeline.
>
> #### Payload
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The task-completed entry as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] Task Completion Logged
>
> **Slug:** `CLOSE_TASK_COMPLETION_LOGGED`
>
> **Type:** webhook
>
> Triggers 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
>
> **data** `object` *required*
>
> The task-completed entry, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] WhatsApp Message Deleted
>
> **Slug:** `CLOSE_WHATSAPP_MESSAGE_DELETED`
>
> **Type:** webhook
>
> Triggers when a WhatsApp message is deleted from a lead's timeline.
>
> #### Configuration
>
> **direction** `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
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `object` *required*
>
> The WhatsApp message as it last existed, immediately before it was removed.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] WhatsApp Message Logged
>
> **Slug:** `CLOSE_WHATSAPP_MESSAGE_LOGGED`
>
> **Type:** webhook
>
> Triggers 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
>
> **direction** `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
>
> **data** `object` *required*
>
> The WhatsApp message, as Close delivered it.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **request\_id** `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.
>
> **user\_id** `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.

> [accordion] WhatsApp Message Updated
>
> **Slug:** `CLOSE_WHATSAPP_MESSAGE_UPDATED`
>
> **Type:** webhook
>
> Triggers when a recorded WhatsApp message changes.
>
> #### Configuration
>
> **changed\_field** `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.
>
> **direction** `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
>
> **changed\_fields** `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.
>
> **data** `object` *required*
>
> The WhatsApp message as it stands after the change.
>
> **meta** `object` *required*
>
> What Close recorded about the request that produced this event.
>
> **previous\_data** `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.
>
> **request\_id** `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.
>
> **user\_id** `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.
