Freshworks Developer Platform Docs

onCompanyCreate FreshdeskFreshdesk Omni

When a company record is created in the Freshworks system, the onCompanyCreate event is triggered.

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

manifest.json

"events": {
  "onCompanyCreate": {
    "handler": "onCompanyCreateCallback"
  }
}

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

server.js

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

Attributes of the data object

actorobject
Information pertaining to the entity who created the company record. An agent, a contact (requester), or the Freshdesk system can create the record.
For example, when a contact is created in the Freshdesk system, if a company is specified for the contact, the onCompanyCreate event is auto-triggered by the Freshdesk system. In this case, the actor is the system.
- account_idinteger
  Identifier of the organization’s Freshdesk account, auto-generated when the account is configured.
- activeboolean
  Specifies whether the actor is active in the Freshdesk system.
  Possible values: true, false
- addressstring
  Residential address of the actor, as specified in the Freshdesk system. If the actor is the Freshdesk system, this value is null.
- blockedboolean
  Specifies whether the actor is blocked in the Freshdesk system, for exceeding the number of login attempts.
  Possible values: true, false
- blocked_atstring
  Timestamp of when the actor was blocked from accessing the Freshdesk system due to multiple failed login attempts, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- citystring
  Name of the city where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- company_idstring
  Identifier of the company to which the actor belongs, auto-generated when a new company record is created in the Freshdesk system.
  For onCompanyCreate, this attribute value is null.
- countrystring
  Name of the country where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- created_atstring
  Timestamp of when the actor’s record was created in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this value is null.
- current_login_atstring
  Timestamp of when the actor logged in to the Freshdesk system or Customer Support Portal to trigger the product event, specified in the UTC format.
- current_login_ipstring
  IP address from which the actor triggered the product event.
  If the actor is the Freshdesk system, this attribute value is null.
- customer_idstring
  Identifier of the end user/contact/requester who triggered the product event.
  Note:Any person using an organization’s Customer Support Portal is the end user. Any end user who raises a ticket in the Customer Support Portal is a requester. Any person whose contact information is stored in the Freshdesk system is a contact/customer.
  For onCompanyCreate, this attribute value is null. If the actor is an agent or the Freshdesk system, this attribute value is null.
- deletedboolean
  Specifies whether the actor was previously part of the Freshdesk system and the actor’s record was deleted from the Freshdesk system.
  This attribute is true, only for actors who are requestors using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
  Possible values: true, false
- deleted_atstring
  Timestamp of when the actor’s record was deleted from the Freshdesk system, specified in the UTC format.
  This attribute contains a valid value, only for actors who are requesters using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
- descriptionstring
  Meaningful description about the actor, specified when the actor information is created in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- emailstring
  Email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- extnstring
  Work phone number extension of the actor.
- failed_login_countinteger
  Number of times the actor attempts to login and fails. Multiple, incorrect login attempts trigger the security protocol and lock the actor out of the Freshdesk account.
  If the actor is the Freshdesk system, this attribute value is null.
- fb_profile_idstring
  If an organization’s Freshdesk system is integrated with Facebook, when a post or comment with specific keywords is posted in Facebook, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  fb_profile_id is the identifier of the account whose post in Facebook triggered the product event.
- first_namestring
  Business name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- helpdesk_agentboolean
  Specifies whether an agent triggered the product event.
  Possible values: true, false
- idinteger
  Identifier of the actor who triggered the product event.
  If the actor is an agent, the id value is the agent’s id that is auto-generated when the agent’s information is configured in the Freshdesk system.
  If the actor is a contact/end user/customer, the id value is the contact or user’s id that is auto-generated when the contact’s information is configured in the Freshdesk system.
  If the actor is the Freshdesk system, the id value is null.
- import_idstring
  Contacts’ records can be imported through a CSV file, in bulk, into the Freshdesk system. The import_id attribute is the identifier of the import task that creates the actor in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- job_titlestring
  Designation of the actor in the actor’s organization or company.
  If the actor is the Freshdesk system, this attribute value is null.
- languagestring
  Primary language of the actor, in the ISO-639 code. If the actor is the Freshdesk system, this attribute value is null.
- last_login_atstring
  Timestamp of when the actor last logged in to the Freshdesk system or Customer Support Portal, specified in the UTC format.
- last_login_ipstring
  IP address of the actor’s previous login before the login that triggered the product event.
- last_namestring
  Surname of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- last_seen_atstring
  Timestamp of when the actor was last active in the Freshdesk system, specified in the UTC format.
- login_countinteger
  Number of successful logins to the Freshdesk system or Customer Support Portal.
- mobilestring
  Mobile phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- namestring
  Full name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- org_agent_idstring
  If the actor is an agent, this attribute value is the organization-level identifier of the agent.
  If the actor is an end user/contact or the Freshdesk system, this attribute value is null.
- org_contact_idstring
  If the actor is an end user/contact in the Freshdesk system, this attribute value is the organization-level identifier of the contact.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- other_company_idsarray of strings
  In the Freshdesk system, a contact can be associated with multiple companies. other_company_ids are the identifiers of all companies the contact is associated with.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- other_emailsarray of strings
  Additional email addresses of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- parent_idinteger
  If the product event is triggered as a result of the actor raising a ticket in the freshdesk system, parent_id is the identifier of the parent ticket raised. Sub/child tickets can be created for a parent ticket, to increase an organization’s help desk performance.
- phonestring
  Official phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- posts_countinteger
  Number of posts that the actor has published in the organization’s forum in the agent portal or Customer Support Portal.
  If the actor is the Freshdesk system, this value is null.
- preferencesobject
  Preferences of the agent when using the Freshdesk system and parameters that indicate the deletion status of an ex-agent who is now a user.
  agent_preferencesobject
  Preferences of the agent when using the Freshdesk system. If the actor is an end user/contact or the Freshdesk system, all child attribute values are null.
  falcon_uiboolean
  Specifies whether the agent is using an updated version of the Freshdesk user interface.
  Possible values: true, false
  field_serviceobject
  Preference of the agent to use the scheduling dashboard with real data.
  dismissed_sample_scheduling_dashboardboolean
  If true, specifies that the agent dismissed the sample scheduling dashboard and preferred to view real time data in the dashboard.
  Possible values: true, false
  focus_modeboolean
  Specifies whether the agent has enabled the focus mode in the agent’s profile settings, to queue tickets for fast resolution.
  Possible values: true, false
  notification_timestampstring
  Timestamp of when the actor received the last notification from the Freshdesk system. This attribute value is null, if the actor hasn’t received any notification from the system.
  search_settingsobject
  Search preferences of the agent, set my navigating to Search > Settings in the Freshdesk system.
  ticketsobject
  Search preferences set for tickets.
  include_attachment_namesboolean
  Specifies whether to look for the search keywords in the attachment file names, when searching for tickets.
  Possible values: true, false
  include_descriptionboolean
  Specifies whether to search for keywords in the ticket description.
  Possible values: true, false
  include_notesboolean
  Specifies whether to search for keywords in the notes and replies.
  Possible values: true, false
  include_other_propertiesboolean
  Specifies whether to search for keywords in ticket properties.
  Possible values: true, false
  include_subjectboolean
  Specifies whether to search for keywords in the ticket subject.
  Possible values: true, false
  shortcuts_enabledboolean
  Specifies whether the agent has enabled Keyboard shortcuts in the agent’s profile settings. These shortcuts can be used to perform repetitive tasks quickly.
  Possible values: true, false
  shortcuts_mappingarray of strings
  Keyboard shortcuts that the agent predominantly uses.
  undo_sendboolean
  Specifies whether the agent has enabled the Undo Send option. If this option is enabled, the agent can use the Undo Send button within 10 seconds of replying, to stop and recall the email that is sent accidentally.
  Possible values: true, false
  password_expiry_datestring
  Date by when the password set by the actor expires.
  user_preferencesobject
  Parameters that specify the deletion status of an actor who is disabled/deleted as an agent but is still in the Freshdesk system as an end user/contact.
  agent_deleted_foreverboolean
  Specifies whether the agent credentials of the user have been deleted permanently from the Freshdesk system.
  Possible values: true, false
  marked_for_hard_deleteboolean
  Specifies whether an agent has been marked for permanent deletion internally in the Freshdesk system. When a hard delete request comes in, the Freshdesk system marks the record for hard deletion, performs mandatory checks, and only then deletes the record.
  Possible values: true, false
  was_agentboolean
  If the actor is an end user/contact, was_agent specifies whether the actor was previously registered as an agent in the Freshdesk system.
  Possible values: true, false
- privilegesstring
  The roles associated with an agent determine the access privileges of the agent. If the actor is an agent, the privileges attribute value is a string identifying the set of privileges for the agent.
  If no role is specified, the default privileges of an Agent role is associated with the agent.
  If the actor is not an agent, this attribute value is null.
- sanitized_mobilestring
  Mobile phone number of the agent or end user/contact, verified and sanitized (formatted to a specific standard) when the agent or contact record is created in the Freshdesk system.
  If the actor is the Freshdesk system, this attribute value is null.
- sanitized_phonestring
  Verified and sanitized (formatted to a specific standard) official phone number of the agent or end user/contact.
  If the actor is the Freshdesk system, this attribute value is null.
- second_emailstring
  Secondary email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- statestring
  Name of the province where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- tagsarray of strings
  Keywords associated with a contact/end user/customer. The keywords help to filter a subset of contacts from all contacts in the system.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- time_zonestring
  Time zone to which the actor belongs, in an easily consumable (RAILS timezone.name) format.
  If the actor is the Freshdesk system, this attribute value is null.
- timezonestring
  Time zone to which the actor belongs, in the Area/Location format.
  If the actor is the Freshdesk system, this attribute value is null.
- twitter_idstring
  Twitter ID of the actor.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- typestring
  Specifies if it is an agent, end user/contact/customer, or the Freshdesk system that triggered the product event.
  Possible values: agent, contact
- unique_external_idstring
  Contact’s identifier in an external system. This identifier helps to connect an end user/contact/customer in the Freshdesk system to the contact’s details in all other systems in the organization.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- updated_atstring
  Timestamp of when the actor’s record is last updated in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- user_rolestring
  If the actor is an end-user/contact, user_role contains a value that the Freshdesk system uses for internal purposes.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- visitor_idstring
  If an organization’s Freshdesk system is integrated with compatible social channels, when a post or comment with specific keywords is posted in the social channel, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  vistior_id is the identifier of the visitor whose post in a social channel triggered the product event.
- whitelistedboolean
  Specifies whether the domain from which the actor triggered the product event is whitelisted in the Freshdesk system.
  For more information, see domain whitelisting.
  If the actor is the Freshdesk system, this attribute value is false.
  Possible values: true, false
companyobject
Information pertaining to the company to which a contact belongs.
- account_idinteger
  Identifier of the Freshdesk account, auto-generated when the account is configured for an organization.
- account_tierstring
  Tier to which the company belongs, according to the organization using Freshdesk.
  Example values: Basic, Premium, Enterprise, and so on.
  Note:An admin who sets up the Freshdesk system, can configure the possible account_tier values.
- avatarstring
  URL of the image used as the avatar in the company profile.
- created_atstring
  Timestamp of when the company was created in the Freshdesk system, specified in the UTC format.
- cust_identifierstring
  When a contact is created in the Freshdesk system, if a company is specified for the contact, a company record is auto-created. All contacts in the Freshdesk system are considered as customers.
  This attribute is the identifier of the contact (customer) whose record creation auto-triggered the onCompanyCreate event. For an onCompanyCreate event that is triggered when an agent creates a new company, this attribute value is null.
  For the onCompanyUpdate event, this value is null.
- custom_fieldsobject
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- deltaboolean
  Possible values: true, false
- descriptionstring
  Company summary that is specified when creating a company in the Freshdesk system.
- domainsarray of strings
  Domain names associated with the company. A company can have multiple domains associated with it.
- health_scorestring
  Indicator of the relationship strength between the organization using Freshdesk and the company created.
  Example values: Happy, Doing ok, At risk, and so on. Note:An admin who sets up the Freshdesk system, can configure the possible health_score values.
- idinteger
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- import_idstring
  Company records can be imported through a CSV file, in bulk, into the Freshdesk system.
  The import_id attribute is the identifier of the import task that created the company record.
- industrystring
  Industry category to which the company belongs.
  Example values: Aerospace, Automotive, Consumer Durables and Apparel, Diversified Consumer Services, and so on.
  Note:An admin who sets up the Freshdesk system, can configure the possible industry values.
- namestring
  Registered name of the company that is specified when creating a company or contact in Freshdesk system.
- notestring
  Specific notes about the company. For example, this attribute can contain the details about a recent deal closed by the company.
- renewal_datestring
  Date on which the organization’s contract (if any)with the company is due for renewal.
- sla_policy_idinteger
  Identifier of the default service-level agreement (SLA) policy in the Freshdesk system. When a company is created in the Freshdesk system, the default SLA policy applies to all tickets from the company.
- updated_atstring
  Timestamp of when the company details were last updated in the Freshdesk system, specified in the UTC format.
  For onCompanyCreate, the updated_at value is the same as the created_at value.

Sample payload

{
  "currentHost": {
    "subscribed_modules": [ "support_company" ],
    "endpoint_urls": {
      "freshdesk": "https://subdomain.freshdesk.com"
    },
    "product_types": {
      "freshdesk": "DEFAULT"
    }
  },
  "data": {
    "actor": {
      "account_id": 13,
      "active": true,
      "address": null,
      "blocked": false,
      "blocked_at": null,
      "city": null,
      "company_id": null,
      "country": null,
      "created_at": "2020-11-10T05:21:53Z",
      "current_login_at": "2021-11-05T12:43:09Z",
      "current_login_ip": "100.25.62.61",
      "customer_id": null,
      "deleted": false,
      "deleted_at": null,
      "delta": true,
      "description": null,
      "email": "jason.test@example.com",
      "external_id": null,
      "extn": null,
      "failed_login_count": 0,
      "fb_profile_id": null,
      "first_name": "Jason",
      "helpdesk_agent": true,
      "id": 48,
      "import_id": null,
      "job_title": null,
      "language": "en",
      "last_login_at": "2021-11-05T12:42:56Z",
      "last_login_ip": "13.234.188.229",
      "last_name": null,
      "last_seen_at": null,
      "login_count": 1371,
      "mobile": null,
      "name": "Jason Teski",
      "org_agent_id": "246574923996993384",
      "org_contact_id": null,
      "other_company_ids": [],
      "other_emails": [],
      "parent_id": 0,
      "phone": "0987654321",
      "posts_count": 0,
      "preferences": {
        "agent_preferences": {
          "falcon_ui": false,
          "field_service": {
            "dismissed_sample_scheduling_dashboard": false
          },
          "focus_mode": true,
          "notification_timestamp": null,
          "search_settings": {
            "tickets": {
              "include_attachment_names": true,
              "include_description": true,
              "include_notes": true,
              "include_other_properties": true,
              "include_subject": true
            }
          },
          "shortcuts_enabled": true,
          "shortcuts_mapping": [],
          "show_loyalty_upgrade": false,
          "show_monthly_to_annual_notification": true,
          "show_onBoarding": true,
          "undo_send": false
        },
        "password_expiry_date": "2120-10-17 05:21:53 UTC",
        "user_preferences": {
          "agent_deleted_forever": false,
          "marked_for_hard_delete": false,
          "was_agent": false
        }
      },
      "privileges": "193248897710135786048173323961003191631436058972055363553917057189806079",
      "sanitized_mobile": null,
      "sanitized_phone": "0987654321",
      "second_email": null,
      "state": null,
      "tags": [],
      "time_zone": "Eastern Time (US & Canada)",
      "timezone": "America/New_York",
      "twitter_id": null,
      "type": "agent",
      "unique_external_id": null,
      "updated_at": "2020-11-11T10:02:35Z",
      "user_role": null,
      "visitor_id": null,
      "whitelisted": false
    },
    "company": {
      "account_id": 13,
      "account_tier": "Premium",
      "avatar": null,
      "created_at": "2021-11-05T12:48:04Z",
      "cust_identifier": null,
      "custom_fields": [],
      "delta": true,
      "description": "Specializes in CRM system",
      "domains": [
        "acmeinc.com"
      ],
      "health_score": "Happy",
      "id": 32,
      "import_id": null,
      "industry": "Aerospace",
      "name": "Acme Inc.",
      "note": "Sales division of Acme",
      "renewal_date": "2020-12-31T00:00:00Z",
      "sla_policy_id": 1000000403489,
      "updated_at": "2021-11-05T12:48:04Z"
    }
  },
  "event": "onCompanyCreate",
  "region": "US",
  "timestamp": 1636116484.5748038
}

onCompanyUpdate FreshdeskFreshdesk Omni

When company details are modified in the Freshworks system, the onCompanyUpdate event is triggered.

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

manifest.json

"events": {
  "onCompanyUpdate": {
    "handler": "onCompanyUpdateCallback"
  }
}

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

server.js

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

Attributes of the data object

actorobject
Information pertaining to the entity who updated the company record. An agent can update the company details.
- account_idinteger
  Identifier of the organization’s Freshdesk account, auto-generated when the account is configured.
- activeboolean
  Specifies whether the actor is active in the Freshdesk system.
  Possible values: true, false
- addressstring
  Residential address of the actor, as specified in the Freshdesk system. If the actor is the Freshdesk system, this value is null.
- blockedboolean
  Specifies whether the actor is blocked in the Freshdesk system, for exceeding the number of login attempts.
  Possible values: true, false
- blocked_atstring
  Timestamp of when the actor was blocked from accessing the Freshdesk system due to multiple failed login attempts, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- citystring
  Name of the city where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- company_idstring
  Identifier of the company to which the actor belongs, auto-generated when a new company record is created in the Freshdesk system.
  For onCompanyCreate, this attribute value is null.
- countrystring
  Name of the country where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- created_atstring
  Timestamp of when the actor’s record was created in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this value is null.
- current_login_atstring
  Timestamp of when the actor logged in to the Freshdesk system or Customer Support Portal to trigger the product event, specified in the UTC format.
- current_login_ipstring
  IP address from which the actor triggered the product event.
  If the actor is the Freshdesk system, this attribute value is null.
- customer_idstring
  Identifier of the end user/contact/requester who triggered the product event.
  Note:Any person using an organization’s Customer Support Portal is the end user. Any end user who raises a ticket in the Customer Support Portal is a requester. Any person whose contact information is stored in the Freshdesk system is a contact/customer.
  For onCompanyCreate, this attribute value is null. If the actor is an agent or the Freshdesk system, this attribute value is null.
- deletedboolean
  Specifies whether the actor was previously part of the Freshdesk system and the actor’s record was deleted from the Freshdesk system.
  This attribute is true, only for actors who are requestors using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
  Possible values: true, false
- deleted_atstring
  Timestamp of when the actor’s record was deleted from the Freshdesk system, specified in the UTC format.
  This attribute contains a valid value, only for actors who are requesters using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
- descriptionstring
  Meaningful description about the actor, specified when the actor information is created in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- emailstring
  Email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- extnstring
  Work phone number extension of the actor.
- failed_login_countinteger
  Number of times the actor attempts to login and fails. Multiple, incorrect login attempts trigger the security protocol and lock the actor out of the Freshdesk account.
  If the actor is the Freshdesk system, this attribute value is null.
- fb_profile_idstring
  If an organization’s Freshdesk system is integrated with Facebook, when a post or comment with specific keywords is posted in Facebook, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  fb_profile_id is the identifier of the account whose post in Facebook triggered the product event.
- first_namestring
  Business name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- helpdesk_agentboolean
  Specifies whether an agent triggered the product event.
  Possible values: true, false
- idinteger
  Identifier of the actor who triggered the product event.
  If the actor is an agent, the id value is the agent’s id that is auto-generated when the agent’s information is configured in the Freshdesk system.
  If the actor is a contact/end user/customer, the id value is the contact or user’s id that is auto-generated when the contact’s information is configured in the Freshdesk system.
  If the actor is the Freshdesk system, the id value is null.
- import_idstring
  Contacts’ records can be imported through a CSV file, in bulk, into the Freshdesk system. The import_id attribute is the identifier of the import task that creates the actor in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- job_titlestring
  Designation of the actor in the actor’s organization or company.
  If the actor is the Freshdesk system, this attribute value is null.
- languagestring
  Primary language of the actor, in the ISO-639 code. If the actor is the Freshdesk system, this attribute value is null.
- last_login_atstring
  Timestamp of when the actor last logged in to the Freshdesk system or Customer Support Portal, specified in the UTC format.
- last_login_ipstring
  IP address of the actor’s previous login before the login that triggered the product event.
- last_namestring
  Surname of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- last_seen_atstring
  Timestamp of when the actor was last active in the Freshdesk system, specified in the UTC format.
- login_countinteger
  Number of successful logins to the Freshdesk system or Customer Support Portal.
- mobilestring
  Mobile phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- namestring
  Full name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- org_agent_idstring
  If the actor is an agent, this attribute value is the organization-level identifier of the agent.
  If the actor is an end user/contact or the Freshdesk system, this attribute value is null.
- org_contact_idstring
  If the actor is an end user/contact in the Freshdesk system, this attribute value is the organization-level identifier of the contact.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- other_company_idsarray of strings
  In the Freshdesk system, a contact can be associated with multiple companies. other_company_ids are the identifiers of all companies the contact is associated with.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- other_emailsarray of strings
  Additional email addresses of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- parent_idinteger
  If the product event is triggered as a result of the actor raising a ticket in the freshdesk system, parent_id is the identifier of the parent ticket raised. Sub/child tickets can be created for a parent ticket, to increase an organization’s help desk performance.
- phonestring
  Official phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- posts_countinteger
  Number of posts that the actor has published in the organization’s forum in the agent portal or Customer Support Portal.
  If the actor is the Freshdesk system, this value is null.
- preferencesobject
  Preferences of the agent when using the Freshdesk system and parameters that indicate the deletion status of an ex-agent who is now a user.
  agent_preferencesobject
  Preferences of the agent when using the Freshdesk system. If the actor is an end user/contact or the Freshdesk system, all child attribute values are null.
  falcon_uiboolean
  Specifies whether the agent is using an updated version of the Freshdesk user interface.
  Possible values: true, false
  field_serviceobject
  Preference of the agent to use the scheduling dashboard with real data.
  dismissed_sample_scheduling_dashboardboolean
  If true, specifies that the agent dismissed the sample scheduling dashboard and preferred to view real time data in the dashboard.
  Possible values: true, false
  focus_modeboolean
  Specifies whether the agent has enabled the focus mode in the agent’s profile settings, to queue tickets for fast resolution.
  Possible values: true, false
  notification_timestampstring
  Timestamp of when the actor received the last notification from the Freshdesk system. This attribute value is null, if the actor hasn’t received any notification from the system.
  search_settingsobject
  Search preferences of the agent, set my navigating to Search > Settings in the Freshdesk system.
  ticketsobject
  Search preferences set for tickets.
  include_attachment_namesboolean
  Specifies whether to look for the search keywords in the attachment file names, when searching for tickets.
  Possible values: true, false
  include_descriptionboolean
  Specifies whether to search for keywords in the ticket description.
  Possible values: true, false
  include_notesboolean
  Specifies whether to search for keywords in the notes and replies.
  Possible values: true, false
  include_other_propertiesboolean
  Specifies whether to search for keywords in ticket properties.
  Possible values: true, false
  include_subjectboolean
  Specifies whether to search for keywords in the ticket subject.
  Possible values: true, false
  shortcuts_enabledboolean
  Specifies whether the agent has enabled Keyboard shortcuts in the agent’s profile settings. These shortcuts can be used to perform repetitive tasks quickly.
  Possible values: true, false
  shortcuts_mappingarray of strings
  Keyboard shortcuts that the agent predominantly uses.
  undo_sendboolean
  Specifies whether the agent has enabled the Undo Send option. If this option is enabled, the agent can use the Undo Send button within 10 seconds of replying, to stop and recall the email that is sent accidentally.
  Possible values: true, false
  password_expiry_datestring
  Date by when the password set by the actor expires.
  user_preferencesobject
  Parameters that specify the deletion status of an actor who is disabled/deleted as an agent but is still in the Freshdesk system as an end user/contact.
  agent_deleted_foreverboolean
  Specifies whether the agent credentials of the user have been deleted permanently from the Freshdesk system.
  Possible values: true, false
  marked_for_hard_deleteboolean
  Specifies whether an agent has been marked for permanent deletion internally in the Freshdesk system. When a hard delete request comes in, the Freshdesk system marks the record for hard deletion, performs mandatory checks, and only then deletes the record.
  Possible values: true, false
  was_agentboolean
  If the actor is an end user/contact, was_agent specifies whether the actor was previously registered as an agent in the Freshdesk system.
  Possible values: true, false
- privilegesstring
  The roles associated with an agent determine the access privileges of the agent. If the actor is an agent, the privileges attribute value is a string identifying the set of privileges for the agent.
  If no role is specified, the default privileges of an Agent role is associated with the agent.
  If the actor is not an agent, this attribute value is null.
- sanitized_mobilestring
  Mobile phone number of the agent or end user/contact, verified and sanitized (formatted to a specific standard) when the agent or contact record is created in the Freshdesk system.
  If the actor is the Freshdesk system, this attribute value is null.
- sanitized_phonestring
  Verified and sanitized (formatted to a specific standard) official phone number of the agent or end user/contact.
  If the actor is the Freshdesk system, this attribute value is null.
- second_emailstring
  Secondary email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- statestring
  Name of the province where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- tagsarray of strings
  Keywords associated with a contact/end user/customer. The keywords help to filter a subset of contacts from all contacts in the system.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- time_zonestring
  Time zone to which the actor belongs, in an easily consumable (RAILS timezone.name) format.
  If the actor is the Freshdesk system, this attribute value is null.
- timezonestring
  Time zone to which the actor belongs, in the Area/Location format.
  If the actor is the Freshdesk system, this attribute value is null.
- twitter_idstring
  Twitter ID of the actor.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- typestring
  Specifies if it is an agent, end user/contact/customer, or the Freshdesk system that triggered the product event.
  Possible values: agent, contact
- unique_external_idstring
  Contact’s identifier in an external system. This identifier helps to connect an end user/contact/customer in the Freshdesk system to the contact’s details in all other systems in the organization.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- updated_atstring
  Timestamp of when the actor’s record is last updated in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- user_rolestring
  If the actor is an end-user/contact, user_role contains a value that the Freshdesk system uses for internal purposes.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- visitor_idstring
  If an organization’s Freshdesk system is integrated with compatible social channels, when a post or comment with specific keywords is posted in the social channel, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  vistior_id is the identifier of the visitor whose post in a social channel triggered the product event.
- whitelistedboolean
  Specifies whether the domain from which the actor triggered the product event is whitelisted in the Freshdesk system.
  For more information, see domain whitelisting.
  If the actor is the Freshdesk system, this attribute value is false.
  Possible values: true, false
companyobject
Information pertaining to the company whose details are modified in the Freshdesk system.
- account_idinteger
  Identifier of the Freshdesk account, auto-generated when the account is configured for an organization.
- account_tierstring
  Tier to which the company belongs, according to the organization using Freshdesk.
  Example values: Basic, Premium, Enterprise, and so on.
  Note:An admin who sets up the Freshdesk system, can configure the possible account_tier values.
- avatarstring
  URL of the image used as the avatar in the company profile.
- changesobject
  Changes that triggered the onCompanyUpdate event, specified as a JSON object of the following format:
  "changes": { //For non-array attributes "<company.attribute that changed>": ["Old value", "New value"] }
  Example:
  "changes": { "name": ["Acme Spacecrafts", "Acme Inc2."], "description": ["Spaceship Manufacturing Company", "Space Shuttle Manufacturing"], "string_cc02": ["Premium", "Enterprise"], "string_cc03": [null, "Aerospace and Defense"] }
- created_atstring
  Timestamp of when the company was created in the Freshdesk system, specified in the UTC format.
- cust_identifierstring
  When a contact is created in the Freshdesk system, if a company is specified for the contact, a company record is auto-created. All contacts in the Freshdesk system are considered as customers.
  This attribute is the identifier of the contact (customer) whose record creation auto-triggered the onCompanyCreate event. For an onCompanyCreate event that is triggered when an agent creates a new company, this attribute value is null.
  For the onCompanyUpdate event, this value is null.
- custom_fieldsobject
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- deltaboolean
  Possible values: true, false
- descriptionstring
  Company summary that is specified when creating a company in the Freshdesk system.
- domainsarray of strings
  Domain names associated with the company. A company can have multiple domains associated with it.
- health_scorestring
  Indicator of the relationship strength between the organization using Freshdesk and the company created.
  Example values: Happy, Doing ok, At risk, and so on. Note:An admin who sets up the Freshdesk system, can configure the possible health_score values.
- idinteger
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- import_idstring
  Company records can be imported through a CSV file, in bulk, into the Freshdesk system.
  The import_id attribute is the identifier of the import task that created the company record.
- industrystring
  Industry category to which the company belongs.
  Example values: Aerospace, Automotive, Consumer Durables and Apparel, Diversified Consumer Services, and so on.
  Note:An admin who sets up the Freshdesk system, can configure the possible industry values.
- namestring
  Registered name of the company that is specified when creating a company or contact in Freshdesk system.
- notestring
  Specific notes about the company. For example, this attribute can contain the details about a recent deal closed by the company.
- renewal_datestring
  Date on which the organization’s contract (if any)with the company is due for renewal.
- sla_policy_idinteger
  Identifier of the default service-level agreement (SLA) policy in the Freshdesk system. When a company is created in the Freshdesk system, the default SLA policy applies to all tickets from the company.
- updated_atstring
  Timestamp of when the company details were last updated in the Freshdesk system, specified in the UTC format.
  For onCompanyCreate, the updated_at value is the same as the created_at value.

Sample payload

{
  "currentHost": {
    "subscribed_modules": [ "support_company" ],
    "endpoint_urls": {
      "freshdesk": "https://subdomain.freshdesk.com"
    },
    "product_types": {
      "freshdesk": "DEFAULT"
    }
  },
  "data": {
    "actor": {
      "account_id": 13,
      "active": true,
      "address": null,
      "blocked": false,
      "blocked_at": null,
      "city": null,
      "company_id": null,
      "country": null,
      "created_at": "2020-11-10T05:21:53Z",
      "current_login_at": "2021-11-05T12:43:09Z",
      "current_login_ip": "100.25.62.61",
      "customer_id": null,
      "deleted": false,
      "deleted_at": null,
      "delta": true,
      "description": null,
      "email": "jason.test@example.com",
      "external_id": null,
      "extn": null,
      "failed_login_count": 0,
      "fb_profile_id": null,
      "first_name": "Jason Teski",
      "helpdesk_agent": true,
      "id": 48,
      "import_id": null,
      "job_title": null,
      "language": "en",
      "last_login_at": "2021-11-05T12:42:56Z",
      "last_login_ip": "13.234.188.229",
      "last_name": null,
      "last_seen_at": null,
      "login_count": 1371,
      "mobile": null,
      "name": "Jason Teski",
      "org_agent_id": "246574923996993384",
      "org_contact_id": null,
      "other_company_ids": [],
      "other_emails": [],
      "parent_id": 0,
      "phone": "0987654321",
      "posts_count": 0,
      "preferences": {
        "agent_preferences": {
          "falcon_ui": false,
          "field_service": {
            "dismissed_sample_scheduling_dashboard": false
          },
          "focus_mode": true,
          "notification_timestamp": null,
          "search_settings": {
            "tickets": {
              "include_attachment_names": true,
              "include_description": true,
              "include_notes": true,
              "include_other_properties": true,
              "include_subject": true
            }
          },
          "shortcuts_enabled": true,
          "shortcuts_mapping": [],
          "show_loyalty_upgrade": false,
          "show_monthly_to_annual_notification": true,
          "show_onBoarding": true,
          "undo_send": false
        },
        "password_expiry_date": "2120-10-17 05:21:53 UTC",
        "user_preferences": {
          "agent_deleted_forever": false,
          "marked_for_hard_delete": false,
          "was_agent": false
        }
      },
      "privileges": "193248897710135786048173323961003191631436058972055363553917057189806079",
      "sanitized_mobile": null,
      "sanitized_phone": "0987654321",
      "second_email": null,
      "state": null,
      "tags": [],
      "time_zone": "Eastern Time (US & Canada)",
      "timezone": "America/New_York",
      "twitter_id": null,
      "type": "agent",
      "unique_external_id": null,
      "updated_at": "2020-11-11T10:02:35Z",
      "user_role": null,
      "visitor_id": null,
      "whitelisted": false
    },
    "company": {
      "account_id": 13,
      "account_tier": "Enterprise",
      "avatar": null,
      "changes": {
        "description": [
          "Space Shuttle Manufacturing",
          "Spaceship Manufacturing Company"
        ],
        "name": [
          "Acme Inc2.",
          "Acme Spacecrafts"
        ],
        "string_cc02": [
          "Enterprise",
          "Premium"
        ],
        "string_cc03": [
          "Aerospace and Defense",
          null
        ]
      },
      "created_at": "2021-11-05T12:48:04Z",
      "cust_identifier": null,
      "custom_fields": [],
      "delta": true,
      "description": "Space Shuttle Manufacturing",
      "domains": [
        "acmeinc.com"
      ],
      "health_score": "Happy",
      "id": 32,
      "import_id": null,
      "industry": "Aerospace and Defense",
      "name": "Acme Inc.",
      "note": null,
      "renewal_date": "2020-12-31T00:00:00Z",
      "sla_policy_id": 1000000403489,
      "updated_at": "2021-11-05T12:48:05Z"
    }
  },
  "event": "onCompanyUpdate",
  "region": "US",
  "timestamp": 1636116485.3058197
}

onCompanyDelete FreshdeskFreshdesk Omni

When a company record is deleted from the Freshworks system, the onCompanyDelete event is triggered.

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

manifest.json

"events": {
  "onCompanyDelete": {
    "handler": "onCompanyDeleteCallback"
  }
}

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

server.js

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

Attributes of the data object

actorobject
Information pertaining to the entity who updated the company record. An agent can update the company details.
- account_idinteger
  Identifier of the organization’s Freshdesk account, auto-generated when the account is configured.
- activeboolean
  Specifies whether the actor is active in the Freshdesk system.
  Possible values: true, false
- addressstring
  Residential address of the actor, as specified in the Freshdesk system. If the actor is the Freshdesk system, this value is null.
- blockedboolean
  Specifies whether the actor is blocked in the Freshdesk system, for exceeding the number of login attempts.
  Possible values: true, false
- blocked_atstring
  Timestamp of when the actor was blocked from accessing the Freshdesk system due to multiple failed login attempts, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- citystring
  Name of the city where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- company_idstring
  Identifier of the company to which the actor belongs, auto-generated when a new company record is created in the Freshdesk system.
  For onCompanyCreate, this attribute value is null.
- countrystring
  Name of the country where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- created_atstring
  Timestamp of when the actor’s record was created in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this value is null.
- current_login_atstring
  Timestamp of when the actor logged in to the Freshdesk system or Customer Support Portal to trigger the product event, specified in the UTC format.
- current_login_ipstring
  IP address from which the actor triggered the product event.
  If the actor is the Freshdesk system, this attribute value is null.
- customer_idstring
  Identifier of the end user/contact/requester who triggered the product event.
  Note:Any person using an organization’s Customer Support Portal is the end user. Any end user who raises a ticket in the Customer Support Portal is a requester. Any person whose contact information is stored in the Freshdesk system is a contact/customer.
  For onCompanyCreate, this attribute value is null. If the actor is an agent or the Freshdesk system, this attribute value is null.
- deletedboolean
  Specifies whether the actor was previously part of the Freshdesk system and the actor’s record was deleted from the Freshdesk system.
  This attribute is true, only for actors who are requestors using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
  Possible values: true, false
- deleted_atstring
  Timestamp of when the actor’s record was deleted from the Freshdesk system, specified in the UTC format.
  This attribute contains a valid value, only for actors who are requesters using the Customer Support Portal and whose contact does not exist in the Freshdesk system.
- descriptionstring
  Meaningful description about the actor, specified when the actor information is created in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- emailstring
  Email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- extnstring
  Work phone number extension of the actor.
- failed_login_countinteger
  Number of times the actor attempts to login and fails. Multiple, incorrect login attempts trigger the security protocol and lock the actor out of the Freshdesk account.
  If the actor is the Freshdesk system, this attribute value is null.
- fb_profile_idstring
  If an organization’s Freshdesk system is integrated with Facebook, when a post or comment with specific keywords is posted in Facebook, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  fb_profile_id is the identifier of the account whose post in Facebook triggered the product event.
- first_namestring
  Business name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- helpdesk_agentboolean
  Specifies whether an agent triggered the product event.
  Possible values: true, false
- idinteger
  Identifier of the actor who triggered the product event.
  If the actor is an agent, the id value is the agent’s id that is auto-generated when the agent’s information is configured in the Freshdesk system.
  If the actor is a contact/end user/customer, the id value is the contact or user’s id that is auto-generated when the contact’s information is configured in the Freshdesk system.
  If the actor is the Freshdesk system, the id value is null.
- import_idstring
  Contacts’ records can be imported through a CSV file, in bulk, into the Freshdesk system. The import_id attribute is the identifier of the import task that creates the actor in the Freshdesk system.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- job_titlestring
  Designation of the actor in the actor’s organization or company.
  If the actor is the Freshdesk system, this attribute value is null.
- languagestring
  Primary language of the actor, in the ISO-639 code. If the actor is the Freshdesk system, this attribute value is null.
- last_login_atstring
  Timestamp of when the actor last logged in to the Freshdesk system or Customer Support Portal, specified in the UTC format.
- last_login_ipstring
  IP address of the actor’s previous login before the login that triggered the product event.
- last_namestring
  Surname of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- last_seen_atstring
  Timestamp of when the actor was last active in the Freshdesk system, specified in the UTC format.
- login_countinteger
  Number of successful logins to the Freshdesk system or Customer Support Portal.
- mobilestring
  Mobile phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- namestring
  Full name of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- org_agent_idstring
  If the actor is an agent, this attribute value is the organization-level identifier of the agent.
  If the actor is an end user/contact or the Freshdesk system, this attribute value is null.
- org_contact_idstring
  If the actor is an end user/contact in the Freshdesk system, this attribute value is the organization-level identifier of the contact.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- other_company_idsarray of strings
  In the Freshdesk system, a contact can be associated with multiple companies. other_company_ids are the identifiers of all companies the contact is associated with.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- other_emailsarray of strings
  Additional email addresses of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- parent_idinteger
  If the product event is triggered as a result of the actor raising a ticket in the freshdesk system, parent_id is the identifier of the parent ticket raised. Sub/child tickets can be created for a parent ticket, to increase an organization’s help desk performance.
- phonestring
  Official phone number of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- posts_countinteger
  Number of posts that the actor has published in the organization’s forum in the agent portal or Customer Support Portal.
  If the actor is the Freshdesk system, this value is null.
- preferencesobject
  Preferences of the agent when using the Freshdesk system and parameters that indicate the deletion status of an ex-agent who is now a user.
  agent_preferencesobject
  Preferences of the agent when using the Freshdesk system. If the actor is an end user/contact or the Freshdesk system, all child attribute values are null.
  falcon_uiboolean
  Specifies whether the agent is using an updated version of the Freshdesk user interface.
  Possible values: true, false
  field_serviceobject
  Preference of the agent to use the scheduling dashboard with real data.
  dismissed_sample_scheduling_dashboardboolean
  If true, specifies that the agent dismissed the sample scheduling dashboard and preferred to view real time data in the dashboard.
  Possible values: true, false
  focus_modeboolean
  Specifies whether the agent has enabled the focus mode in the agent’s profile settings, to queue tickets for fast resolution.
  Possible values: true, false
  notification_timestampstring
  Timestamp of when the actor received the last notification from the Freshdesk system. This attribute value is null, if the actor hasn’t received any notification from the system.
  search_settingsobject
  Search preferences of the agent, set my navigating to Search > Settings in the Freshdesk system.
  ticketsobject
  Search preferences set for tickets.
  include_attachment_namesboolean
  Specifies whether to look for the search keywords in the attachment file names, when searching for tickets.
  Possible values: true, false
  include_descriptionboolean
  Specifies whether to search for keywords in the ticket description.
  Possible values: true, false
  include_notesboolean
  Specifies whether to search for keywords in the notes and replies.
  Possible values: true, false
  include_other_propertiesboolean
  Specifies whether to search for keywords in ticket properties.
  Possible values: true, false
  include_subjectboolean
  Specifies whether to search for keywords in the ticket subject.
  Possible values: true, false
  shortcuts_enabledboolean
  Specifies whether the agent has enabled Keyboard shortcuts in the agent’s profile settings. These shortcuts can be used to perform repetitive tasks quickly.
  Possible values: true, false
  shortcuts_mappingarray of strings
  Keyboard shortcuts that the agent predominantly uses.
  undo_sendboolean
  Specifies whether the agent has enabled the Undo Send option. If this option is enabled, the agent can use the Undo Send button within 10 seconds of replying, to stop and recall the email that is sent accidentally.
  Possible values: true, false
  password_expiry_datestring
  Date by when the password set by the actor expires.
  user_preferencesobject
  Parameters that specify the deletion status of an actor who is disabled/deleted as an agent but is still in the Freshdesk system as an end user/contact.
  agent_deleted_foreverboolean
  Specifies whether the agent credentials of the user have been deleted permanently from the Freshdesk system.
  Possible values: true, false
  marked_for_hard_deleteboolean
  Specifies whether an agent has been marked for permanent deletion internally in the Freshdesk system. When a hard delete request comes in, the Freshdesk system marks the record for hard deletion, performs mandatory checks, and only then deletes the record.
  Possible values: true, false
  was_agentboolean
  If the actor is an end user/contact, was_agent specifies whether the actor was previously registered as an agent in the Freshdesk system.
  Possible values: true, false
- privilegesstring
  The roles associated with an agent determine the access privileges of the agent. If the actor is an agent, the privileges attribute value is a string identifying the set of privileges for the agent.
  If no role is specified, the default privileges of an Agent role is associated with the agent.
  If the actor is not an agent, this attribute value is null.
- sanitized_mobilestring
  Mobile phone number of the agent or end user/contact, verified and sanitized (formatted to a specific standard) when the agent or contact record is created in the Freshdesk system.
  If the actor is the Freshdesk system, this attribute value is null.
- sanitized_phonestring
  Verified and sanitized (formatted to a specific standard) official phone number of the agent or end user/contact.
  If the actor is the Freshdesk system, this attribute value is null.
- second_emailstring
  Secondary email address of the actor.
  If the actor is the Freshdesk system, this attribute value is null.
- statestring
  Name of the province where the actor is located.
  This attribute contains a non-null value only if the actor (type: agent) is an Account administrator who has subscribed for the Freshdesk plan by providing their credentials for billing.
- tagsarray of strings
  Keywords associated with a contact/end user/customer. The keywords help to filter a subset of contacts from all contacts in the system.
  If the actor is an agent or the Freshdesk system, this attribute value is an empty array.
- time_zonestring
  Time zone to which the actor belongs, in an easily consumable (RAILS timezone.name) format.
  If the actor is the Freshdesk system, this attribute value is null.
- timezonestring
  Time zone to which the actor belongs, in the Area/Location format.
  If the actor is the Freshdesk system, this attribute value is null.
- twitter_idstring
  Twitter ID of the actor.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- typestring
  Specifies if it is an agent, end user/contact/customer, or the Freshdesk system that triggered the product event.
  Possible values: agent, contact
- unique_external_idstring
  Contact’s identifier in an external system. This identifier helps to connect an end user/contact/customer in the Freshdesk system to the contact’s details in all other systems in the organization.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- updated_atstring
  Timestamp of when the actor’s record is last updated in the Freshdesk system, specified in the UTC format.
  If the actor is the Freshdesk system, this attribute value is null.
- user_rolestring
  If the actor is an end-user/contact, user_role contains a value that the Freshdesk system uses for internal purposes.
  If the actor is an agent or the Freshdesk system, this attribute value is null.
- visitor_idstring
  If an organization’s Freshdesk system is integrated with compatible social channels, when a post or comment with specific keywords is posted in the social channel, the post is converted into a ticket in the Freshdesk system. This conversion triggers certain product events.
  vistior_id is the identifier of the visitor whose post in a social channel triggered the product event.
- whitelistedboolean
  Specifies whether the domain from which the actor triggered the product event is whitelisted in the Freshdesk system.
  For more information, see domain whitelisting.
  If the actor is the Freshdesk system, this attribute value is false.
  Possible values: true, false
companyobject
Information pertaining to the company whose details are modified in the Freshdesk system.
- account_idinteger
  Identifier of the Freshdesk account, auto-generated when the account is configured for an organization.
- avatarstring
  URL of the image used as the avatar in the company profile.
- cust_identifierstring
  When a contact is created in the Freshdesk system, if a company is specified for the contact, a company record is auto-created. All contacts in the Freshdesk system are considered as customers.
  This attribute is the identifier of the contact (customer) whose record creation auto-triggered the onCompanyCreate event. For an onCompanyCreate event that is triggered when an agent creates a new company, this attribute value is null.
  For the onCompanyUpdate event, this value is null.
- custom_fieldsobject
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- deltaboolean
  Possible values: true, false
- idinteger
  Identifier of the company object, auto-generated when a company record is created in the Freshdesk system.
- import_idstring
  Company records can be imported through a CSV file, in bulk, into the Freshdesk system.
  The import_id attribute is the identifier of the import task that created the company record.
- namestring
  Registered name of the company that is specified when creating a company or contact in Freshdesk system.
- sla_policy_idinteger
  Identifier of the default service-level agreement (SLA) policy in the Freshdesk system. When a company is created in the Freshdesk system, the default SLA policy applies to all tickets from the company.

Sample payload

{
  "currentHost": {
    "subscribed_modules": [ "support_company" ],
    "endpoint_urls": {
      "freshdesk": "https://subdomain.freshdesk.com"
    },
    "product_types": {
      "freshdesk": "DEFAULT"
    }
  },
  "data": {
    "actor": {
      "account_id": 13,
      "active": true,
      "address": null,
      "blocked": false,
      "blocked_at": null,
      "city": null,
      "company_id": null,
      "country": null,
      "created_at": "2020-11-10T05:21:53Z",
      "current_login_at": "2021-11-05T12:43:09Z",
      "current_login_ip": "100.25.62.61",
      "customer_id": null,
      "deleted": false,
      "deleted_at": null,
      "delta": true,
      "description": null,
      "email": "jason.test@example.com",
      "external_id": null,
      "extn": null,
      "failed_login_count": 0,
      "fb_profile_id": null,
      "first_name": "Jason Teski",
      "helpdesk_agent": true,
      "id": 48,
      "import_id": null,
      "job_title": null,
      "language": "en",
      "last_login_at": "2021-11-05T12:42:56Z",
      "last_login_ip": "13.234.188.229",
      "last_name": null,
      "last_seen_at": null,
      "login_count": 1371,
      "mobile": null,
      "name": "Jason Teski",
      "org_agent_id": "246574923996993384",
      "org_contact_id": null,
      "other_company_ids": [],
      "other_emails": [],
      "parent_id": 0,
      "phone": "0987654321",
      "posts_count": 0,
      "preferences": {
        "agent_preferences": {
          "falcon_ui": false,
          "field_service": {
            "dismissed_sample_scheduling_dashboard": false
          },
          "focus_mode": true,
          "notification_timestamp": null,
          "search_settings": {
            "tickets": {
              "include_attachment_names": true,
              "include_description": true,
              "include_notes": true,
              "include_other_properties": true,
              "include_subject": true
            }
          },
          "shortcuts_enabled": true,
          "shortcuts_mapping": [],
          "show_loyalty_upgrade": false,
          "show_monthly_to_annual_notification": true,
          "show_onBoarding": true,
          "undo_send": false
        },
        "password_expiry_date": "2120-10-17 05:21:53 UTC",
        "user_preferences": {
          "agent_deleted_forever": false,
          "marked_for_hard_delete": false,
          "was_agent": false
        }
      },
      "privileges": "193248897710135786048173323961003191631436058972055363553917057189806079",
      "sanitized_mobile": null,
      "sanitized_phone": "0987654321",
      "second_email": null,
      "state": null,
      "tags": [],
      "time_zone": "Eastern Time (US & Canada)",
      "timezone": "America/New_York",
      "twitter_id": null,
      "type": "agent",
      "unique_external_id": null,
      "updated_at": "2020-11-11T10:02:35Z",
      "user_role": null,
      "visitor_id": null,
      "whitelisted": false
    },
    "company": {
      "account_id": 13,
      "avatar": null,
      "cust_identifier": null,
      "custom_fields": null,
      "delta": null,
      "id": 32,
      "import_id": null,
      "name": "Acme Inc.",
      "sla_policy_id": null
    }
  },
  "event": "onCompanyDelete",
  "region": "US",
  "timestamp": 1636116486.0663662
}

Configure onCompanyCreate, onCompanyUpdate, and onCompanyDelete

onCompanyCreate FreshdeskFreshdesk Omni

Attributes of the data object

onCompanyUpdate FreshdeskFreshdesk Omni

Attributes of the data object

onCompanyDelete FreshdeskFreshdesk Omni

Attributes of the data object