Volver al catálogo

Close

close

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

Acciones
6
Triggers
45
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (6)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create SMS MessageCLOSE_CLOSE_CREATE_SMSAcción

This tool creates a new sms message in close. the tool allows sending immediate sms messages or logging received sms messages using the provided phone numbers and message content. it includes parameters such as local phone, remote phone, text, status, and source.

Parámetros de entrada

  • textstringObligatorio

    The content of the SMS message

  • statusstringObligatorioenum

    The status of the SMS. Must be one of: inbox, draft, scheduled, outbox, sent

    inboxdraftscheduledoutboxsent
  • lead_idstringObligatorio

    The ID of the lead associated with the SMS

  • send_ininteger

    Number of seconds to delay sending the SMS when status is outbox. Must be less than 60

  • directionstringenum

    The direction of the SMS. Defaults to 'inbound' if status is inbox, otherwise 'outbound'

    inboundoutbound
  • contact_idstring

    The ID of the contact associated with the SMS

  • local_phonestringObligatorio

    The internal phone number used to send the SMS. Must be associated with a Phone Number of type 'internal'

  • template_idstring

    The ID of an SMS Template to render and use as the message content

  • remote_phonestringObligatorio

    The recipient's phone number

  • date_scheduledstring

    The date and time when the SMS should be sent (required if status is 'scheduled')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CallCLOSE_CREATE_CALLAcción

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.

Parámetros de entrada

  • notestring

    A text note about the call

  • phonestring

    The phone number associated with the call

  • lead_idstringObligatorio

    The ID of the lead associated with the call

  • user_idstring

    The ID of the user who made/received the call

  • durationinteger

    Duration of the call in seconds

  • directionstringObligatorioenum

    The direction of the call (outbound or inbound)

    outboundinbound
  • contact_idstring

    The ID of the contact associated with the call

  • dispositionstringenum

    The outcome of the call (answered, no-answer, vm-answer, vm-left, busy, blocked, error, abandoned)

    answeredno-answervm-answervm-leftbusyblockederrorabandoned
  • recording_urlstringuri

    HTTPS URL pointing to the MP3 recording of the call

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create LeadCLOSE_CREATE_LEADAcción

This tool creates a new lead in close crm. it allows users to create a lead with basic company information and optional contact details, including company name, description, website url, lead status, contacts, and addresses. it operates by sending a request to the api endpoint /lead/ on the close crm platform.

Parámetros de entrada

  • urlstring

    Website URL of the company

  • namestringObligatorio

    Name of the company/lead

  • contactsobject[]

    List of contacts associated with the lead

  • addressesobject[]

    List of addresses associated with the lead

  • status_idstring

    ID of the lead status. If not provided, organization's default status will be used

  • descriptionstring

    Description of the lead

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TaskCLOSE_CREATE_TASKAcción

This tool creates a new task in close.com. tasks are used to track to-do items and can be associated with leads. the tool will create a task with the specified parameters using the provided text, due date, and is complete flags.

Parámetros de entrada

  • datestringObligatorio

    The date when the task is actionable. Can be date-only (YYYY-MM-DD) or date-time (YYYY-MM-DDThh:mm:ss+00:00)

  • textstringObligatorio

    Description of the task

  • lead_idstringObligatorio

    The ID of the lead the task is associated with

  • assigned_tostring

    User ID of the person the task is assigned to. If omitted, assigns to the API caller

  • is_completeboolean

    Whether the task is complete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CallCLOSE_DELETE_CALLAcción

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.

Parámetros de entrada

  • call_idstringObligatorio

    The unique identifier of the call activity to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get NotesCLOSE_GET_NOTEAcción

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.

Parámetros de entrada

  • lead_idstring

    Filter notes by a specific lead ID

  • user_idstring

    Filter notes by a specific user ID

  • date_created__gtstring

    Filter notes created after this date (ISO 8601 format)

  • date_created__ltstring

    Filter notes created before this date (ISO 8601 format)

Parámetros de salida

  • dataobject[]Obligatorio

    Array of notes matching the search criteria

  • errorstring

    Error if any occurred during the execution of the action

  • has_morebooleanObligatorio

    Whether there are more results available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Triggers (45)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Bulk Delete CompletedCLOSE_BULK_DELETE_COMPLETEDTrigger

Triggers when a bulk delete finishes.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk delete, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Delete CreatedCLOSE_BULK_DELETE_CREATEDTrigger

Triggers when a bulk delete is started.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk delete, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Delete UpdatedCLOSE_BULK_DELETE_UPDATEDTrigger

Triggers when a bulk delete makes progress, carrying how many records it has handled so far.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The bulk delete as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Bulk Edit CompletedCLOSE_BULK_EDIT_COMPLETEDTrigger

Triggers when a bulk edit finishes.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk edit, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Edit CreatedCLOSE_BULK_EDIT_CREATEDTrigger

Triggers when a bulk edit is started.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk edit, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Edit UpdatedCLOSE_BULK_EDIT_UPDATEDTrigger

Triggers when a bulk edit makes progress, carrying how many records it has handled so far.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The bulk edit as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Bulk Email CreatedCLOSE_BULK_EMAIL_CREATEDTrigger

Triggers when a bulk email send is started.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk email send, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Email PausedCLOSE_BULK_EMAIL_PAUSEDTrigger

Triggers when a bulk email send is paused, either by a person or by Close itself.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk email send, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Email UpdatedCLOSE_BULK_EMAIL_UPDATEDTrigger

Triggers when a bulk email send makes progress, carrying how many recipients it has handled so far.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The bulk email send as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Bulk Sequence Subscription CompletedCLOSE_BULK_SEQUENCE_SUBSCRIPTION_COMPLETEDTrigger

Triggers when a bulk sequence action finishes.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk sequence action, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Sequence Subscription CreatedCLOSE_BULK_SEQUENCE_SUBSCRIPTION_CREATEDTrigger

Triggers when a bulk sequence subscribe, pause or resume is started.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The bulk sequence action, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Bulk Sequence Subscription UpdatedCLOSE_BULK_SEQUENCE_SUBSCRIPTION_UPDATEDTrigger

Triggers when a bulk sequence action makes progress, carrying how many contacts it has handled so far.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The bulk sequence action as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Call DeletedCLOSE_CALL_DELETEDTrigger

Triggers when a call is deleted from a lead's timeline.

Configuración

  • directionstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The call as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Call LoggedCLOSE_CALL_LOGGEDTrigger

Triggers when a call is recorded on a lead, whether placed through Close or logged after the fact. Filter on `direction` for inbound only.

Configuración

  • directionstring

    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 del evento

  • dataobjectObligatorio

    The call, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Call UpdatedCLOSE_CALL_UPDATEDTrigger

Triggers when a recorded call changes, such as its note, outcome, recording or transcript.

Configuración

  • changed_fieldstring

    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.

  • directionstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The call as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Comment AddedCLOSE_COMMENT_ADDEDTrigger

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.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The comment, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Custom Activity DeletedCLOSE_CUSTOM_ACTIVITY_DELETEDTrigger

Triggers when a custom activity instance is deleted from a lead.

Configuración

  • custom_activity_type_idstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The custom activity as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Custom Activity LoggedCLOSE_CUSTOM_ACTIVITY_LOGGEDTrigger

Triggers when an instance of a custom activity type is logged on a lead. Filter on `custom_activity_type_id` for one type only.

Configuración

  • custom_activity_type_idstring

    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 del evento

  • dataobjectObligatorio

    The custom activity, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Custom Activity UpdatedCLOSE_CUSTOM_ACTIVITY_UPDATEDTrigger

Triggers when an existing custom activity instance changes.

Configuración

  • changed_fieldstring

    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_idstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The custom activity as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Email DeletedCLOSE_EMAIL_DELETEDTrigger

Triggers when an email is deleted from a lead's timeline.

Configuración

  • directionstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The email as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Email LoggedCLOSE_EMAIL_LOGGEDTrigger

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.

Configuración

  • directionstring

    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 del evento

  • dataobjectObligatorio

    The email, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Email Thread DeletedCLOSE_EMAIL_THREAD_DELETEDTrigger

Triggers when an email thread is deleted from a lead.

Configuración

Sin parámetros.

Payload del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The email thread as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Email Thread StartedCLOSE_EMAIL_THREAD_STARTEDTrigger

Triggers when a new email thread appears on a lead. The individual messages arrive separately on CLOSE_EMAIL_LOGGED.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The email thread, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Email Thread UpdatedCLOSE_EMAIL_THREAD_UPDATEDTrigger

Triggers when an email thread changes, such as a message being added to it or its subject changing.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The email thread as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Email UpdatedCLOSE_EMAIL_UPDATEDTrigger

Triggers when a recorded email changes, such as a draft being edited, an open being recorded, or its status moving.

Configuración

  • changed_fieldstring

    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.

  • directionstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The email as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Lead Creation Activity AddedCLOSE_LEAD_CREATION_ACTIVITY_ADDEDTrigger

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.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The 'Lead Created' timeline entry, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Lead Creation Activity DeletedCLOSE_LEAD_CREATION_ACTIVITY_DELETEDTrigger

Triggers when a 'Lead Created' timeline entry is removed, which means its lead was deleted.

Configuración

Sin parámetros.

Payload del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The 'Lead Created' timeline entry as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Lead Creation Activity UpdatedCLOSE_LEAD_CREATION_ACTIVITY_UPDATEDTrigger

Triggers when a 'Lead Created' timeline entry is moved to a different lead, which in practice means its lead was merged into another.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The 'Lead Created' timeline entry as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Lead Status ChangedCLOSE_LEAD_STATUS_CHANGEDTrigger

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.

Configuración

  • new_statusstring

    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 del evento

  • dataobjectObligatorio

    The lead status change, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Lead Status Change Entry DeletedCLOSE_LEAD_STATUS_CHANGE_ENTRY_DELETEDTrigger

Triggers when a lead-status-change entry is removed from a lead's timeline.

Configuración

  • new_statusstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The lead status change as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Lead Status Change Entry UpdatedCLOSE_LEAD_STATUS_CHANGE_ENTRY_UPDATEDTrigger

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.

Configuración

  • changed_fieldstring

    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_statusstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The lead status change as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Note AddedCLOSE_NOTE_ADDEDTrigger

Triggers when a note is written on a lead.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The note, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Note DeletedCLOSE_NOTE_DELETEDTrigger

Triggers when a note is deleted from a lead.

Configuración

Sin parámetros.

Payload del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The note as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Note UpdatedCLOSE_NOTE_UPDATEDTrigger

Triggers when an existing note is edited.

Configuración

  • changed_fieldstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The note as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Opportunity Status ChangedCLOSE_OPPORTUNITY_STATUS_CHANGEDTrigger

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.

Configuración

  • new_statusstring

    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_typestring

    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.

  • pipelinestring

    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 del evento

  • dataobjectObligatorio

    The opportunity status change, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

Opportunity Status Change Entry DeletedCLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_DELETEDTrigger

Triggers when an opportunity-status-change entry is removed from a lead's timeline.

Configuración

  • new_statusstring

    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_typestring

    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.

  • pipelinestring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The opportunity status change as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Opportunity Status Change Entry UpdatedCLOSE_OPPORTUNITY_STATUS_CHANGE_ENTRY_UPDATEDTrigger

Triggers when Close folds a further status change into an existing opportunity-status-change timeline entry.

Configuración

  • changed_fieldstring

    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_statusstring

    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_typestring

    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.

  • pipelinestring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The opportunity status change as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

SMS DeletedCLOSE_SMS_DELETEDTrigger

Triggers when an SMS is deleted from a lead's timeline.

Configuración

  • directionstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The SMS as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

SMS LoggedCLOSE_SMS_LOGGEDTrigger

Triggers when an SMS is recorded on a lead. Filter on `direction` for inbound only.

Configuración

  • directionstring

    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 del evento

  • dataobjectObligatorio

    The SMS, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

SMS UpdatedCLOSE_SMS_UPDATEDTrigger

Triggers when a recorded SMS changes, such as its status moving or a delivery error being recorded.

Configuración

  • changed_fieldstring

    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.

  • directionstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The SMS as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.

Task Completion Entry DeletedCLOSE_TASK_COMPLETION_ENTRY_DELETEDTrigger

Triggers when a 'task completed' entry is removed from a lead's timeline.

Configuración

Sin parámetros.

Payload del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The task-completed entry as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

Task Completion LoggedCLOSE_TASK_COMPLETION_LOGGEDTrigger

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.

Configuración

Sin parámetros.

Payload del evento

  • dataobjectObligatorio

    The task-completed entry, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

WhatsApp Message DeletedCLOSE_WHATSAPP_MESSAGE_DELETEDTrigger

Triggers when a WhatsApp message is deleted from a lead's timeline.

Configuración

  • directionstring

    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 del evento

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    The WhatsApp message as it last existed, immediately before it was removed.

  • request_idstring

    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_idstring

    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.

WhatsApp Message LoggedCLOSE_WHATSAPP_MESSAGE_LOGGEDTrigger

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.

Configuración

  • directionstring

    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 del evento

  • dataobjectObligatorio

    The WhatsApp message, as Close delivered it.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • request_idstring

    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_idstring

    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.

WhatsApp Message UpdatedCLOSE_WHATSAPP_MESSAGE_UPDATEDTrigger

Triggers when a recorded WhatsApp message changes.

Configuración

  • changed_fieldstring

    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.

  • directionstring

    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 del evento

  • changed_fieldsstring[]Obligatorio

    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.

  • dataobjectObligatorio

    The WhatsApp message as it stands after the change.

  • metaobjectObligatorio

    What Close recorded about the request that produced this event.

  • previous_dataobjectObligatorio

    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_idstring

    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_idstring

    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.