Freshworks Developer Platform Docs

Marketplace Platform v2.3 deprecation:We’re continuing to improve the Marketplace Platform to deliver stronger security, better performance, and new capabilities. As part of this evolution, Marketplace Platform v2.3 will be deprecated. To learn the dates and next steps, see Migration guide.

onDealCreate

When a deal is created, the onDealCreate event is invoked and the registered callback method is executed.

Subscribe to the onDealCreate event and register the callback by using the following sample manifest.json content.

manifest.json

"events": {
  "onDealCreate": {
    "handler": "onDealCreateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

server.js

exports = {
  onDealCreateCallback: function(payload) {
    console.log("Logging arguments from onDealCreate event: " + JSON.stringify(payload));
    }
  }

Attributes of the data object

actorobject
Information pertaining to the entity who triggered the onDealCreate event.
- created_atstring
  Timestamp of when the actor is created in the Freshsales Suite system, specified in the UTC format.
- deal_pipeline_idinteger
  Identifier of deal pipelines that the actor is part of.
- emailstring
  Email address of the actor.
- idinteger
  Identifier associated with the actor.
- is_activeboolean
  Specifies whether the actor is verified.
  Possible values: true, false
- is_forgottenboolean
  Specifies whether the specified data is deleted permanently from the Freshsales Suite system.
  Possible values: true, false
- job_titlestring
  Designation of the actor.
- languagestring
  Language of the actor; by default, language is en.
- mobile_numberinteger
  Phone number of the actor.
- namestring
  Name of the actor.
- time_zonestring
  Time zone of the actor, specified in the UTC format.
- typestring
  Category of the actor created.
- updated_atstring
  Timestamp of when the actor is updated in the Freshsales Suite system, specified in the UTC format.
  For onContactCreate, this attribute value is the same as created_at.
- uuidstring
  Universally unique identifier of the actor.
- work_numberinteger
  Official phone number of the actor.
associationsobject
All associated objects of the deal object, which specify additional information pertaining to the deal created.
- campaignstring
  UTM campaign.
- contactsarray
  Contacts associated with this deal.
- creatorobject
  Details of the deal creator.
  created_atstring
  Timestamp of when the user is created in the Freshsales Suite system, specified in the UTC format.
  deal_pipeline_idinteger
  Pipeline helps define different stages a deal progresses through, which enables a unique sales process for each deal.
  Identifier of the pipeline associated with the deal.
  emailstring
  Email address of the user.
  idinteger
  Identifier of the user.
  is_activeboolean
  Specifies whether the user is currently active in the Freshsales Suite system.
  Possible values: true, false
  job_titlestring
  Designation of the user in the Freshsales Suite system.
  mobile_numberstring
  Contact number of the user.
  namestring
  Name of the user.
  time_zonestring
  Time zone of the user configured in the Freshsales Suite system.
  typestring
  Identifier of the person involved in creating, owning, or updating the product.
  Possible value: user
  updated_atstring
  Timestamp of when the user is last updated in the Freshsales Suite system, specified in the UTC format.
  uuidinteger
  Unique user identifier, this value is auto-generated.
  work_numberstring
  Official phone number of the user.
- currencyobject
  Details of the deal currency.
- deal_payment_statusstring
  Status of the deal payment.
- deal_pipelineobject
  Information pertaining to the deal pipeline.
- deal_productstring
  Name of the product that the deal is associated with.
- deal_reasonstring
  Reason why the deal was lost.
- deal_stageobject
  Information pertaining to the deal stage.
- deal_typestring
  Type of the deal.
- ownerobject
  Details of the contact owner.
  created_atstring
  Timestamp of when the user is created in the Freshsales Suite system, specified in the UTC format.
  deal_pipeline_idinteger
  Pipeline helps define different stages a deal progresses through, which enables a unique sales process for each deal.
  Identifier of the pipeline associated with the deal.
  emailstring
  Email address of the user.
  idinteger
  Identifier of the user.
  is_activeboolean
  Specifies whether the user is currently active in the Freshsales Suite system.
  Possible values: true, false
  job_titlestring
  Designation of the user in the Freshsales Suite system.
  mobile_numberstring
  Contact number of the user.
  namestring
  Name of the user.
  time_zonestring
  Time zone of the user configured in the Freshsales Suite system.
  typestring
  Identifier of the person involved in creating, owning, or updating the product.
  Possible value: user
  updated_atstring
  Timestamp of when the user is last updated in the Freshsales Suite system, specified in the UTC format.
  uuidinteger
  Unique user identifier, this value is auto-generated.
  work_numberstring
  Official phone number of the user.
- productsarray
  Products associated with this deal.
- sales_accountsarray of integers
  Sales accounts of the contact.
- sourcestring
  Source details of the deal.
- team_usersarray
  Collaborators who worked on a task related to the deal.
- territorystring
  Location associated with the deal.
- updaterobject
  Details of the deal updater. For the onDealCreate event, this value is null.
dealobject
Details of the deal object created when the onDealCreate event is triggered.
- active_sales_sequencesobject
  Active sales campaigns that this deal was part of.
- ageobject
  Time elapsed (in days) since the creation of the deal.
- amountobject
  Value of the deal.
- base_currency_amountobject
  Deal amount converted to the base currency configured by admin.
- campaign_idobject
  Identifier of the UTM campaign.
- closed_dateobject
  Closed date of the deal.
- completed_sales_sequencesobject
  Completed sales sequences that this deal was part of.
- contact_idsarray
  Identifiers of contacts associated with this deal.
- created_atobject
  Created timestamp.
- creator_idobject
  Identifier of the user who initiated the deal.
- currency_idobject
  Identifier of the currency associated with the deal.
- custom_fieldsarray of strings
  Key value pairs containing the names and values of custom fields.
- deal_payment_status_idobject
  Identifier of the deal payment status.
- deal_pipeline_idinteger
  Identifier of the deal pipeline.
- deal_prediction_tagobject
  Identifier of the user who updated the deal.
- deal_product_idobject
  Identifier of the product that the deal is associated with.
- deal_reason_idobject
  Identifier of the reason why the deal was lost.
- deal_stage_idobject
  Identifier of the deal stage.
- deal_type_idobject
  Identifier of the deal type.
- expected_closeobject
  Expected close date of the deal.
- expected_deal_valueobject
  Expected deal amount.
- first_assigned_atobject
  First assigned timestamp of the deal.
- idinteger
  Identifier of the deal.
- import_csv_idobject
  Reference of all imports that this deal was part of.
- import_idstring
  Identifier of the equivalent record in the external system from which it was imported.
- is_deletedboolean
  Specifies whether the deal is deleted.
  Possible values: true, false
- last_assigned_atobject
  Last assigned timestamp.
- last_contacted_sales_activity_modeobject
  Last mode of sales activity rendered for the deal.
- last_contacted_via_sales_activityobject
  Last contacted timestamp (through sales activity).
- lead_source_idinteger
  Identifier of the source of the deal.
- lost_fromstring
  Stage where the deal was lost.
- nameobject
  Name of the deal.
- owner_idobject
  User who owns the record.
- probabilityinteger
  Probability of closing the deal.
- product_idsarray
  Identifiers of products associated with this deal.
- recent_noteobject
  Recently added note against the deal.
- sales_account_idobject
  Identifier of the sales account associated with this deal.
- source_additional_infoarray
  Meta information specified as a custom JSON object.
- stage_updated_timeobject
  Timestamp when the deal stage was updated.
- tagsobject
  Tags associated with this deal.
- team_user_idsarray
  Identifiers of the collaborators who work on a task associated with the deal.
- territory_idobject
  Identifier of the territory.
- upcoming_activities_timeobject
  Timestamp for the next scheduled activity.
- updated_atobject
  Updated timestamp.
- updater_idobject
  Identifier of the user who updated the deal.
- web_form_idobject
  Form through which this deal was captured.
- won_fromobject
  Stage from which deal was won.

Sample payload

{
  "account_id": "195818342531129946",
  "data": {
    "actor": {
      "created_at": "2020-06-24T08:32:11Z",
      "deal_pipeline_id": 27149,
      "email": "jim.doe@xyz.com",
      "id": 39897,
      "is_active": true,
      "is_forgotten": false,
      "job_title": "Engineer",
      "language": "en",
      "mobile_number": null,
      "name": "Jim Doe",
      "time_zone": "UTC",
      "type": "user",
      "updated_at": "2020-06-24T08:34:20Z",
      "uuid": "195818342547907164",
      "work_number": null
    },
    "associations": {
      "campaign": null,
      "contacts": [],
      "creator": {
        "created_at": "2020-06-24T08:32:11Z",
        "deal_pipeline_id": 27149,
        "email": "jim.doe@xyz.com",
        "id": 39897,
        "is_active": true,
        "job_title": "Engineer",
        "mobile_number": null,
        "name": "Jim Doe",
        "time_zone": "UTC",
        "type": "user",
        "updated_at": "2020-06-24T08:34:20Z",
        "uuid": "195818342547907164",
        "work_number": null
      },
      "currency": {
        "currency_code": "USD",
        "exchange_rate": "1.0",
        "id": 6615
      },
      "deal_payment_status": null,
      "deal_pipeline": {
        "id": 27149,
        "is_default": true,
        "name": "Default Pipeline",
        "position": 1
      },
      "deal_product": null,
      "deal_reason": null,
      "deal_stage": {
        "forecast_type": "Open",
        "id": 178962,
        "name": "New",
        "position": 1
      },
      "deal_type": null,
      "owner": {
        "created_at": "2020-06-24T08:32:11Z",
        "deal_pipeline_id": 27149,
        "email": "jim.doe@xyz.com",
        "id": 39897,
        "is_active": true,
        "job_title": "Engineer",
        "mobile_number": null,
        "name": "Jim Doe",
        "time_zone": "UTC",
        "type": "user",
        "updated_at": "2020-06-24T08:34:20Z",
        "uuid": "195818342547907164",
        "work_number": null
      },
      "products": [],
      "sales_account": null,
      "source": null,
      "team_users": [],
      "territory": null,
      "updater": null
    },
    "deal": {
      "active_sales_sequences": {
        "label": "Active sales sequences",
        "type": "multi_select_dropdown",
        "value": []
      },
      "age": {
        "label": "Age (in days)",
        "type": "integer",
        "value": 0
      },
      "amount": {
        "label": "Deal value",
        "type": "decimal",
        "value": "123.0"
      },
      "base_currency_amount": {
        "label": "Deal value in Base Currency",
        "type": "decimal",
        "value": "123.0"
      },
      "campaign_id": {
        "label": "Campaign",
        "type": "dropdown",
        "value": null
      },
      "closed_date": {
        "label": "Closed date",
        "type": "date",
        "value": null
      },
      "completed_sales_sequences": {
        "label": "Completed sales sequences",
        "type": "multi_select_dropdown",
        "value": []
      },
      "contact_ids": [],
      "created_at": {
        "label": "Created at",
        "type": "date_time",
        "value": "2020-06-24T18:30:54Z"
      },
      "creator_id": {
        "label": "Created by",
        "type": "dropdown",
        "value": 39897
      },
      "currency_id": {
        "label": "Currency",
        "type": "dropdown",
        "value": 6615
      },
      "custom_fields": [],
      "deal_payment_status_id": {
        "label": "Payment status",
        "type": "dropdown",
        "value": null
      },
      "deal_pipeline_id": {
        "label": "Deal pipeline",
        "type": "dropdown",
        "value": 27149
      },
      "deal_prediction_tag": {
        "dom_type": "text",
        "label": "Deal Prediction",
        "value": null
      },
      "deal_product_id": {
        "label": "Product",
        "type": "dropdown",
        "value": null
      },
      "deal_reason_id": {
        "label": "Lost reason",
        "type": "dropdown",
        "value": null
      },
      "deal_stage_id": {
        "label": "Deal stage",
        "type": "dropdown",
        "value": 178962
      },
      "deal_type_id": {
        "label": "Type",
        "type": "dropdown",
        "value": null
      },
      "expected_close": {
        "label": "Expected close date",
        "type": "date",
        "value": null
      },
      "expected_deal_value": {
        "label": "Expected deal value",
        "type": "decimal",
        "value": "123.0"
      },
      "first_assigned_at": {
        "dom_type": "date_time",
        "label": "First assigned at",
        "value": "2020-06-24T18:30:55Z"
      },
      "id": 1357538,
      "import_csv_id": {
        "dom_type": "multi_select_dropdown",
        "label": "Import label",
        "value": []
      },
      "import_id": null,
      "is_deleted": false,
      "last_assigned_at": {
        "label": "Last assigned at",
        "type": "date_time",
        "value": "2020-06-24T18:30:55Z"
      },
      "last_contacted_sales_activity_mode": {
        "label": "Last activity type",
        "type": "dropdown",
        "value": null
      },
      "last_contacted_via_sales_activity": {
        "label": "Last activity date",
        "type": "date_time",
        "value": null
      },
      "lead_source_id": {
        "label": "Source",
        "type": "dropdown",
        "value": null
      },
      "lost_from": null,
      "name": {
        "label": "Name",
        "type": "text",
        "value": "Deal with owner"
      },
      "owner_id": {
        "label": "Sales owner",
        "type": "dropdown",
        "value": 39897
      },
      "probability": {
        "label": "Probability (%)",
        "type": "decimal",
        "value": 100
      },
      "product_ids": [],
      "recent_note": {
        "label": "Recent note",
        "type": "paragraph",
        "value": null
      },
      "sales_account_id": {
        "label": "Account name",
        "type": "auto_complete",
        "value": null
      },
      "source_additional_info": {},
      "stage_updated_time": {
        "label": "Deal stage updated at",
        "type": "date_time",
        "value": "2020-06-24T18:30:54Z"
      },
      "tags": {
        "label": "Tags",
        "type": "auto_complete",
        "value": []
      },
      "team_user_ids": [],
      "territory_id": {
        "label": "Territory",
        "type": "dropdown",
        "value": null
      },
      "upcoming_activities_time": {
        "label": "Upcoming activities",
        "type": "date_time",
        "value": null
      },
      "updated_at": {
        "label": "Updated at",
        "type": "date_time",
        "value": "2020-06-24T18:30:54Z"
      },
      "updater_id": {
        "label": "Updated by",
        "type": "dropdown",
        "value": null
      },
      "web_form_id": {
        "label": "Web form",
        "type": "dropdown",
        "value": null
      },
      "won_from": null
    }
  },
  "domain": "sample.myfreshworks.com",
  "event": "onDealCreate",
  "iparams": {},
  "productContext": {
    "name": "freshworks_crm",
    "url": "https://sample.myfreshworks.com/crm"
  },
  "region": "US",
  "timestamp": 1593023454.5852625,
  "version": "2.0"
}

onDealUpdate

When a deal is updated, the onDealUpdate event is invoked and the registered callback method is executed.

Subscribe to the onDealUpdate event and register the callback by using the following sample manifest.json content.

manifest.json

"events": {
  "onDealUpdate": {
    "handler": "onDealUpdateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

server.js

exports = {
  onDealUpdateCallback: function(payload) {
    console.log("Logging arguments from onDealUpdate event: " + JSON.stringify(payload));
    }
  }

Attributes of the data object

actorobject
Information pertaining to the entity who triggered the onDealUpdate event.
- created_atstring
  Timestamp of when the actor is created in the Freshsales Suite system, specified in the UTC format.
- deal_pipeline_idinteger
  Identifier of deal pipelines that the actor is part of.
- emailstring
  Email address of the actor.
- idinteger
  Identifier associated with the actor.
- is_activeboolean
  Specifies whether the actor is verified.
  Possible values: true, false
- is_forgottenboolean
  Specifies whether the specified data is deleted permanently from the Freshsales Suite system.
  Possible values: true, false
- job_titlestring
  Designation of the actor.
- languagestring
  Language of the actor; by default, language is en.
- mobile_numberinteger
  Phone number of the actor.
- namestring
  Name of the actor.
- time_zonestring
  Time zone of the actor, specified in the UTC format.
- typestring
  Category of the actor created.
- updated_atstring
  Timestamp of when the actor is updated in the Freshsales Suite system, specified in the UTC format.
  For onContactCreate, this attribute value is the same as created_at.
- uuidstring
  Universally unique identifier of the actor.
- work_numberinteger
  Official phone number of the actor.
associationsobject
All associated objects of the deal object, which specify additional information pertaining to the deal updated.
- campaignstring
  UTM campaign.
- contactsarray
  Contacts associated with this deal.
- creatorobject
  Details of the deal creator.
  created_atstring
  Timestamp of when the user is created in the Freshsales Suite system, specified in the UTC format.
  deal_pipeline_idinteger
  Pipeline helps define different stages a deal progresses through, which enables a unique sales process for each deal.
  Identifier of the pipeline associated with the deal.
  emailstring
  Email address of the user.
  idinteger
  Identifier of the user.
  is_activeboolean
  Specifies whether the user is currently active in the Freshsales Suite system.
  Possible values: true, false
  job_titlestring
  Designation of the user in the Freshsales Suite system.
  mobile_numberstring
  Contact number of the user.
  namestring
  Name of the user.
  time_zonestring
  Time zone of the user configured in the Freshsales Suite system.
  typestring
  Identifier of the person involved in creating, owning, or updating the product.
  Possible value: user
  updated_atstring
  Timestamp of when the user is last updated in the Freshsales Suite system, specified in the UTC format.
  uuidinteger
  Unique user identifier, this value is auto-generated.
  work_numberstring
  Official phone number of the user.
- currencyobject
  Details of the deal currency.
- deal_payment_statusstring
  Status of the deal payment.
- deal_pipelineobject
  Information pertaining to the deal pipeline.
- deal_productstring
  Name of the product that the deal is associated with.
- deal_reasonstring
  Reason why the deal was lost.
- deal_stageobject
  Information pertaining to the deal stage.
- deal_typestring
  Type of the deal.
- ownerobject
  Details of the deal owner.
  created_atstring
  Timestamp of when the user is created in the Freshsales Suite system, specified in the UTC format.
  deal_pipeline_idinteger
  Pipeline helps define different stages a deal progresses through, which enables a unique sales process for each deal.
  Identifier of the pipeline associated with the deal.
  emailstring
  Email address of the user.
  idinteger
  Identifier of the user.
  is_activeboolean
  Specifies whether the user is currently active in the Freshsales Suite system.
  Possible values: true, false
  job_titlestring
  Designation of the user in the Freshsales Suite system.
  mobile_numberstring
  Contact number of the user.
  namestring
  Name of the user.
  time_zonestring
  Time zone of the user configured in the Freshsales Suite system.
  typestring
  Identifier of the person involved in creating, owning, or updating the product.
  Possible value: user
  updated_atstring
  Timestamp of when the user is last updated in the Freshsales Suite system, specified in the UTC format.
  uuidinteger
  Unique user identifier, this value is auto-generated.
  work_numberstring
  Official phone number of the user.
- productsarray
  Products associated with this deal.
- sales_accountsarray of integers
  Sales accounts of the contact.
- sourcestring
  Source details of the deal.
- team_usersarray
  Collaborators who worked on a task related to the deal.
- territorystring
  Location associated with the deal.
- updaterobject
  Details of the deal updater. For the onDealCreate event, this value is null.
  created_atstring
  Timestamp of when the user is created in the Freshsales Suite system, specified in the UTC format.
  deal_pipeline_idinteger
  Pipeline helps define different stages a deal progresses through, which enables a unique sales process for each deal.
  Identifier of the pipeline associated with the deal.
  emailstring
  Email address of the user.
  idinteger
  Identifier of the user.
  is_activeboolean
  Specifies whether the user is currently active in the Freshsales Suite system.
  Possible values: true, false
  job_titlestring
  Designation of the user in the Freshsales Suite system.
  mobile_numberstring
  Contact number of the user.
  namestring
  Name of the user.
  time_zonestring
  Time zone of the user configured in the Freshsales Suite system.
  typestring
  Identifier of the person involved in creating, owning, or updating the product.
  Possible value: user
  updated_atstring
  Timestamp of when the user is last updated in the Freshsales Suite system, specified in the UTC format.
  uuidinteger
  Unique user identifier, this value is auto-generated.
  work_numberstring
  Official phone number of the user.
- changesobject
  Information pertaining to the deal whose details are modified in the Freshsales Suite system.
  Changes that triggered the onDealUpdate event, specified as a JSON object of the following format:
  "changes": { "misc_changes": {}, "model_changes": { //For non-array attributes "<deal.attribute that changed>": ["Old value", "New value"] }, "system_changes": {} }
  misc_changesobject
  List of all miscellaneous database parameters whose values have changed, along with the old and modified values.
  model_changesobject
  List of all attributes whose values have changed, along with the old and modified values of the attributes.
  system_changesobject
  List of all system-level parameters whose values have changed, along with the old and modified values.
- dealobject
  Details of the deal object created when the onDealUpdate event is triggered.
  active_sales_sequencesobject
  Active sales campaigns that this deal was part of.
  ageobject
  Time elapsed (in days) since the creation of the deal.
  amountobject
  Value of the deal.
  base_currency_amountobject
  Deal amount converted to the base currency configured by admin.
  campaign_idobject
  Identifier of the UTM campaign.
  closed_dateobject
  Closed date of the deal.
  completed_sales_sequencesobject
  Completed sales sequences that this deal was part of.
  contact_idsarray
  Identifiers of contacts associated with this deal.
  created_atobject
  Created timestamp.
  creator_idobject
  Identifier of the user who initiated the deal.
  currency_idobject
  Identifier of the currency associated with the deal.
  custom_fieldsarray of strings
  Key value pairs containing the names and values of custom fields.
  deal_payment_status_idobject
  Identifier of the deal payment status.
  deal_pipeline_idinteger
  Identifier of the deal pipeline.
  deal_prediction_tagobject
  Identifier of the user who updated the deal.
  deal_product_idobject
  Identifier of the product that the deal is associated with.
  deal_reason_idobject
  Identifier of the reason why the deal was lost.
  deal_stage_idobject
  Identifier of the deal stage.
  deal_type_idobject
  Identifier of the deal type.
  expected_closeobject
  Expected close date of the deal.
  expected_deal_valueobject
  Expected deal amount.
  first_assigned_atobject
  First assigned timestamp of the deal.
  idinteger
  Identifier of the deal.
  import_csv_idobject
  Reference of all imports that this deal was part of.
  import_idstring
  Identifier of the equivalent record in the external system from which it was imported.
  is_deletedboolean
  Specifies whether the deal is deleted.
  Possible values: true, false
  last_assigned_atobject
  Last assigned timestamp.
  last_contacted_sales_activity_modeobject
  Last mode of sales activity rendered for the deal.
  last_contacted_via_sales_activityobject
  Last contacted timestamp (through sales activity).
  lead_source_idinteger
  Identifier of the source of the deal.
  lost_fromstring
  Stage where the deal was lost.
  nameobject
  Name of the deal.
  owner_idobject
  User who owns the record.
  probabilityinteger
  Probability of closing the deal.
  product_idsarray
  Identifiers of products associated with this deal.
  recent_noteobject
  Recently added note against the deal.
  sales_account_idobject
  Identifier of the sales account associated with this deal.
  source_additional_infoarray
  Meta information specified as a custom JSON object.
  stage_updated_timeobject
  Timestamp when the deal stage was updated.
  tagsobject
  Tags associated with this deal.
  team_user_idsarray
  Identifiers of the collaborators who work on a task associated with the deal.
  territory_idobject
  Identifier of the territory.
  upcoming_activities_timeobject
  Timestamp for the next scheduled activity.
  updated_atobject
  Updated timestamp.
  updater_idobject
  Identifier of the user who updated the deal.
  web_form_idobject
  Form through which this deal was captured.
  won_fromobject
  Stage from which deal was won.

Sample payload

{
  "account_id": "195818342531129946",
  "data": {
    "actor": {
      "created_at": "2020-06-24T08:32:11Z",
      "deal_pipeline_id": 27149,
      "email": "jim.doe@xyz.com",
      "id": 39897,
      "is_active": true,
      "is_forgotten": false,
      "job_title": "Engineer",
      "language": "en",
      "mobile_number": null,
      "name": "Jim Doe",
      "time_zone": "UTC",
      "type": "user",
      "updated_at": "2020-06-24T08:34:20Z",
      "uuid": "195818342547907164",
      "work_number": null
    },
    "associations": {
      "campaign": null,
      "contacts": [],
      "creator": {
        "created_at": "2020-06-24T08:32:11Z",
        "deal_pipeline_id": 27149,
        "email": "jim.doe@xyz.com",
        "id": 39897,
        "is_active": true,
        "job_title": "Engineer",
        "mobile_number": null,
        "name": "Jim Doe",
        "time_zone": "UTC",
        "type": "user",
        "updated_at": "2020-06-24T08:34:20Z",
        "uuid": "195818342547907164",
        "work_number": null
      },
      "currency": {
        "currency_code": "USD",
        "exchange_rate": "1.0",
        "id": 6615
      },
      "deal_payment_status": null,
      "deal_pipeline": {
        "id": 27149,
        "is_default": true,
        "name": "Default Pipeline",
        "position": 1
      },
      "deal_product": null,
      "deal_reason": null,
      "deal_stage": {
        "forecast_type": "Open",
        "id": 178962,
        "name": "New",
        "position": 1
      },
      "deal_type": null,
      "owner": {
        "created_at": "2020-06-24T08:32:11Z",
        "deal_pipeline_id": 27149,
        "email": "jim.doe@xyz.com",
        "id": 39897,
        "is_active": true,
        "job_title": "Engineer",
        "mobile_number": null,
        "name": "Jim Doe",
        "time_zone": "UTC",
        "type": "user",
        "updated_at": "2020-06-24T08:34:20Z",
        "uuid": "195818342547907164",
        "work_number": null
      },
      "products": [],
      "sales_account": null,
      "source": null,
      "team_users": [],
      "territory": null,
      "updater": {
        "created_at": "2020-06-24T08:32:11Z",
        "deal_pipeline_id": 27149,
        "email": "jim.doe@xyz.com",
        "id": 39897,
        "is_active": true,
        "job_title": "Engineer",
        "mobile_number": null,
        "name": "Jim Doe",
        "time_zone": "UTC",
        "type": "user",
        "updated_at": "2020-06-24T08:34:20Z",
        "uuid": "195818342547907164",
        "work_number": null
      }
    },
    "changes": {
      "misc_changes": {},
      "model_changes": {
        "amount": [
          123,
          1234
        ],
        "base_currency_amount": [
          123,
          1234
        ],
        "expected_deal_value": [
          123,
          1234
        ],
        "name": [
          "Deal update with owner",
          "Deal with owner"
        ],
        "updated_at": [
          "2020-06-24T18:30:54Z",
          "2020-06-24T18:31:09Z"
        ],
        "updater_id": [
          39897,
          null
        ]
      },
      "system_changes": {}
    },
    "deal": {
      "active_sales_sequences": {
        "label": "Active sales sequences",
        "type": "multi_select_dropdown",
        "value": []
      },
      "age": {
        "label": "Age (in days)",
        "type": "number",
        "value": 0
      },
      "amount": {
        "label": "Deal value",
        "type": "decimal",
        "value": "1234.0"
      },
      "base_currency_amount": {
        "label": "Deal value in Base Currency",
        "type": "decimal",
        "value": "1234.0"
      },
      "campaign_id": {
        "label": "Campaign",
        "type": "dropdown",
        "value": null
      },
      "closed_date": {
        "label": "Closed date",
        "type": "date",
        "value": null
      },
      "completed_sales_sequences": {
        "label": "Completed sales sequences",
        "type": "multi_select_dropdown",
        "value": []
      },
      "contact_ids": [],
      "created_at": {
        "label": "Created at",
        "type": "date_time",
        "value": "2020-06-24T18:30:54Z"
      },
      "creator_id": {
        "label": "Created by",
        "type": "dropdown",
        "value": 39897
      },
      "currency_id": {
        "label": "Currency",
        "type": "dropdown",
        "value": 6615
      },
      "custom_fields": [],
      "deal_payment_status_id": {
        "label": "Payment status",
        "type": "dropdown",
        "value": null
      },
      "deal_pipeline_id": {
        "label": "Deal pipeline",
        "type": "dropdown",
        "value": 27149
      },
      "deal_prediction_tag": {
        "dom_type": "text",
        "label": "Deal Prediction",
        "value": null
      },
      "deal_product_id": {
        "label": "Product",
        "type": "dropdown",
        "value": null
      },
      "deal_reason_id": {
        "label": "Lost reason",
        "type": "dropdown",
        "value": null
      },
      "deal_stage_id": {
        "label": "Deal stage",
        "type": "dropdown",
        "value": 178962
      },
      "deal_type_id": {
        "label": "Type",
        "type": "dropdown",
        "value": null
      },
      "expected_close": {
        "label": "Expected close date",
        "type": "date",
        "value": null
      },
      "expected_deal_value": {
        "label": "Expected deal value",
        "type": "decimal",
        "value": "1234.0"
      },
      "first_assigned_at": {
        "dom_type": "date_time",
        "label": "First assigned at",
        "value": "2020-06-24T18:30:55Z"
      },
      "id": 1357538,
      "import_csv_id": {
        "dom_type": "multi_select_dropdown",
        "label": "Import label",
        "value": []
      },
      "import_id": null,
      "is_deleted": false,
      "last_assigned_at": {
        "label": "Last assigned at",
        "type": "date_time",
        "value": "2020-06-24T18:30:55Z"
      },
      "last_contacted_sales_activity_mode": {
        "label": "Last activity type",
        "type": "dropdown",
        "value": null
      },
      "last_contacted_via_sales_activity": {
        "label": "Last activity date",
        "type": "date_time",
        "value": null
      },
      "lead_source_id": {
        "label": "Source",
        "type": "dropdown",
        "value": null
      },
      "lost_from": null,
      "name": {
        "label": "Name",
        "type": "text",
        "value": "Deal update with owner"
      },
      "owner_id": {
        "label": "Sales owner",
        "type": "dropdown",
        "value": 39897
      },
      "probability": {
        "label": "Probability (%)",
        "type": "decimal",
        "value": 100
      },
      "product_ids": [],
      "recent_note": {
        "label": "Recent note",
        "type": "paragraph",
        "value": null
      },
      "sales_account_id": {
        "label": "Account name",
        "type": "auto_complete",
        "value": null
      },
      "source_additional_info": {},
      "stage_updated_time": {
        "label": "Deal stage updated at",
        "type": "date_time",
        "value": "2020-06-24T18:30:54Z"
      },
      "tags": {
        "label": "Tags",
        "type": "auto_complete",
        "value": []
      },
      "team_user_ids": [],
      "territory_id": {
        "label": "Territory",
        "type": "dropdown",
        "value": null
      },
      "upcoming_activities_time": {
        "label": "Upcoming activities",
        "type": "date_time",
        "value": null
      },
      "updated_at": {
        "label": "Updated at",
        "type": "date_time",
        "value": "2020-06-24T18:31:09Z"
      },
      "updater_id": {
        "label": "Updated by",
        "type": "dropdown",
        "value": 39897
      },
      "web_form_id": {
        "label": "Web form",
        "type": "dropdown",
        "value": null
      },
      "won_from": null
    }
  },
  "domain": "sample.myfreshworks.com",
  "event": "onDealUpdate",
  "iparams": {},
  "productContext": {
      "name": "freshworks_crm",
      "url": "https://sample.myfreshworks.com/crm"
  },
  "region": "US",
  "timestamp": 1593023469.8293262,
  "version": "2.0"
}

Configure onDealCreate and onDealUpdateOn this page

onDealCreate

Attributes of the data object

onDealUpdate

Attributes of the data object

Configure onDealCreate and onDealUpdate