Guía de formato de datos de acción de webhook

Los siguientes son algunos de los campos que estarán disponibles a través de la acción Webhook

Nota : Si bien los datos de los contactos y del objeto de subcuenta (ubicación) estarán disponibles de forma predeterminada, otros objetos relacionados, como citas, tareas, etc., SÓLO se transportarán si se aplica el disparador correspondiente en el flujo de trabajo.

Por ejemplo, la fecha y la hora de las citas solo se pueden recuperar si el flujo de trabajo incluye la referencia de la cita como un disparador de entrada, como Cita reservada. De manera similar, el propietario de la oportunidad de varias oportunidades en el pipeline solo estaría disponible si el flujo de trabajo tiene un disparador de oportunidad, como Pipeline modificado.

En los próximos lanzamientos, planeamos ofrecer un conjunto más sólido de opciones configurables para garantizar que nuestros usuarios puedan aprovechar la función al máximo.

{
  // Campos estándar de contacto
  first_name,
  last_name,
  full_name,
  email,
  phone,
  tags,
  address1,
  city,
  state,
  country,
  timezone,
  date_created,
  postal_code,
  company_name,
  website,
  date_of_birth,
  contact_source,
  full_address,
  contact_type,
  gclid,

  ...
  ... Campos personalizados de contacto 
  ...

  // Los datos de ubicación se presentan principalmente siempre con todos los webhooks, campo clave: location
  location: {
      name,
      address,
      city,
      state,
      country,
      postalCode,
      fullAddress,
      id
  }

  // Oportunidad, si corresponde, agregada en el nivel raíz
  opportunity_name,
  status,
  lead_value,
  opportunity_source,
  source,
  pipleline_stage, // nombre de la etapa del pipeline
  pipeline_id,
  id,
  pipeline_name,

  // Campaña, si corresponde, clave de campo: campaign
  campaign: {
      id,
      name
  },

  // Usuario, si corresponde, clave de campo: user
  user: {
      firstName,
      lastName,
      email,
      phone,
      extension,
      address1,
      city,
      state,
      country,
      postalCode
  },

  // Cita, si corresponde, clave de campo: calendar 
  calendar: {
      id, // calendar id
      calendarName, // calendar.name,
      title, // appointment title
      selectedTimezone, // location timezone OR 'UTC'
      appointmentId,
      startTime: // hora de inicio según la zona horaria seleccionada en formato 'YYYY-MM-DDTHH:mm:ss'
      endTime: // hora de finalización según la zona horaria seleccionada en formato 'YYYY-MM-DDTHH:mm:ss'
      status,
      appoinmentStatus,
      address,
      notes,
      date_created,
      created_by, // nombre de usuario si lo crea el usuario
      created_by_user_id // id de usuario si lo crea el usuario
      created_by_meta: { // campos internos
        source,
        channel
      },
      last_updated_by_meta: { // campos internos
        source,
        channel
      }
  },

  // Formulario de pedido de dos pasos si corresponde, clave de campo: order
  order: {
      ... // Datos dinámicos, ejecute la prueba para obtener datos de ejemplo
  },

  // Factura si corresponde, clave de campo: invoice
  invoice: {
      ... // Datos dinámicos, ejecute la prueba para obtener datos de ejemplo
  },

  // Tarea si corresponde, clave de campo: task
  task: {
      title,
      body,
      dueDate: dueDate convertida a zona horaria UTC con formato 'YYYY-MM-DDTHH:mm:ss'
  }

  // Nota si corresponde, clave de campo: note
  note: {
      body
  }

  // Mensaje si corresponde, clave de campo: message
  message: {
      type,
      body,
      direction,
      status
  }

  // Flujo de trabajo si corresponde, clave de campo: workflow
  workflow: {
      id,
      name
  }
}