Product Events

Events that occur in the Freshcaller product, such as the establishment of a call connection, completion of a call, or transfer of a call, are termed as product events. You can enable product events to trigger apps. To do this, configure event listeners in the server.js file. When a product event occurs, the corresponding event listener invokes a callback method. The app logic in the callback method runs with the help of the event-specific payload passed to the callback method.

Configure Events

To register a product event and the corresponding callback:

  1. From your app’s root directory, navigate to the manifest.json file.
  2. Include the events attribute, specifying the product event and the corresponding callback methods as follows:
    Copied Copy 
    1
    2
    3
    4
    5
    		"events": {
  "<eventName>": {
      "handler": "<eventCallbackMethod>"
  }
}

    Note: Include only one callback method for an event. Multiple events can access the same callback method.

  3. Navigate to the server.js file.
  4. In the exports block, enter the callback function definition as follows:
    Copied Copy 
    1
    2
    3
    4
    5
    6
    7
    		exports = {
      // args is a JSON block containing the payload information
      // args["iparam"] will contain the installation parameter values
      //eventCallbackMethod is the call-back function name specified in manifest.json
      eventCallbackMethod: function(args) {
        console.log("Logging arguments from the event: " + JSON.stringify(payload));
      }};

Payload Attributes

When a product event occurs, an event-specific payload is passed to the callback method.

Copied Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "account_id" : "value",
  "domain" : "value",
  "event"  : "value",
  "region"  : "value",
  "timestamp"  : "value",
  "data" : {
    //Contains the list of objects related to the event.
  },
  "iparams" : {
    "Param1" : "value",
    "Param2" : "value"
  }
}
EXPAND ↓

The payload is a JSON object with the following attributes.

Attribute Type Description
account_id string Identifier of the Freshcaller account, auto-generated when the account is configured for a business.
domain string Domain name for the Freshcaller account. For example, acn.freshcaller.com.
event string Identifier of the product event.
region string Region where the Freshcaller account is deployed.
Possible values: US, EU, EUC, AUS, and IND.
timestamp number Timestamp of when the product event occurs, specified in the epoch format.
iparams object Installation parameters specified as a JSON object of <parameter name>: <parameter value> pairs.
data object Event-specific Freshcaller data, specified as a JSON object of key:value pairs.
onCallCreate

When a call originates from a Freshcaller number or is being received to a Freshcaller number, the onCallCreate event is triggered.

Register the onCallCreate event by using the following sample manifest.json content.

Copied Copy 
1
2
3
4
5
"events": {
  "onCallCreate": {
    "handler": "onCallCreateCallback"
  }
}

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

Copied Copy 
1
2
3
4
5
exports = {
  onCallCreateCallback: function(payload) {
    console.log("Logging arguments from onCallCreateCallback event: " + JSON.stringify(payload));
    }
  }
 Sample Payload 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
  "account_id": "82918",
  "domain": "sample.freshcaller.com",
  "event": "onCallCreate",
  "timestamp": 1583839686,
  "region": "US",
  "data": {
    "call": {
      "phone_number": "+12133701559",
      "root_call_id": null,
      "created_time": "2020-03-10T11:28:05.000Z",
      "assigned_ivr_id": null,
      "assigned_team_id": null,
      "phone_number_id": 46851,
      "participants": [
        {
          "participant_type": "Customer",
          "duration": null,
          "caller_id": 7994085,
          "caller_number": "+11234568791",
          "created_time": "2020-03-10T11:28:05.000Z",
          "connection_type": 0,
          "enqueued_time": null,
          "cost_unit": "usd",
          "duration_unit": "seconds",
          "id": 321,
          "cost": null,
          "participant_id": 318,
          "updated_time": "2020-03-10T11:28:05.000Z",
          "call_id": 135,
          "call_status": 0
        },
        {
          "participant_type": "Agent",
          "duration": null,
          "caller_id": null,
          "caller_number": null,
          "created_time": "2020-03-10T11:28:05.000Z",
          "connection_type": 1,
          "enqueued_time": null,
          "cost_unit": "usd",
          "duration_unit": "seconds",
          "id": 322,
          "cost": null,
          "participant_id": 694,
          "updated_time": "2020-03-10T11:28:05.000Z",
          "call_id": 135,
          "call_status": 8
        }
      ],
      "direction": "outgoing",
      "assigned_call_queue_id": null,
      "id": 135,
      "parent_call_id": null,
      "bill_duration": null,
      "bill_duration_unit": "seconds",
      "updated_time": "2020-03-10T11:28:05.000Z",
      "call_notes": null,
      "recording": null,
      "assigned_agent_id": 139694
    },
    "associations": {},
    "actor": {
      "type": "system"
    }
  }
}
EXPAND ↓
Attributes of the data object
ATTRIBUTE TYPE DESCRIPTION
call call object Details pertaining to the call that triggered the onCallCreate event.
associations object All objects related to the call object.
For onCallCreate, this value is an empty object.
actor actor object Information pertaining to the entity that created the call object.
Attribute of the actor object:
type (string): Identifier of the entity that created the call object. For onCallCreate, this value is system.

Attributes of the call object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the call object, auto-generated when the object is created at the start of a call.
direction integer Direction of the call.
Possible values (enum):
Incoming: The call that triggered onCallCreate was received at a Freshcaller number.
Outgoing: The call that triggered onCallCreate was made from a Freshcaller number.
parent_call_id integer This attribute is valid only for transferred calls. Therefore, for onCallCreate this value is null.
root_call_id integer This attribute is valid only when child calls are created. Therefore, for onCallCreate this value is null.
phone_number_id integer Identifier of the Freshcaller number from which the call is made or to which the call is received. The value is auto-generated when a number is configured in the Freshcaller system.
phone_number string Freshcaller number from which the call is made or to which the call is received.
assigned_agent_id integer Identifier of the primary agent who interacts with the customer.
assigned_team_id integer This attribute is valid only when a call is assigned to a team. Therefore, for onCallCreate this value is null.
assigned_call_queue_id integer For inbound calls, assigned_call_queue_id is the identifier of the call queue associated with the number in which the call is received. The call queue to which a call must be routed is specified when call actions are defined for a Freshcaller number.
For outbound calls, the value is null.
assigned_ivr_id integer For inbound calls, assigned_ivr_id is the identifier of the Interactive Voice Response (ivr) menu associated with the number in which the call is received . The ivr menu is associated with a number when call actions are defined for the number.
For outbound calls and for numbers that don’t have an ivr menu, the value is null.
call_notes string This attribute is valid only on completion of a call. Therefore, for onCallCreate this value is null.
bill_duration integer This attribute is valid only on completion of a call. Therefore, for onCallCreate this value is null.
bill_duration_unit string Unit of time used to express bill_duration.
Possible value: seconds.
created_time string Timestamp of when the call is established, specified in the UTC format.
updated_time string Timestamp of when the attributes of a call are last updated, specified in the UTC format. For onCallCreate, this value is the same as created_time.
recording recording object This attribute is valid only on completion of a call. Therefore, for onCallCreate this value is null.
participants array of callparticipant objects Information about the agent and customer involved in the call.

Attributes of the callparticipant object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the call participant object, auto-generated when the call participant object is created (when a participant joins a call) in the Freshcaller system.
call_id integer Identifier of the call object, auto-generated when the call is initiated.
caller_id integer Identifier of the customer number. For the agent participant_type, the value is null.
caller_number string Customer's phone number from which the call is made or to which the call received. For the agent participant_type, the value is null.
participant_id integer Identifier of the participant; either the agent’s id or customer’s id.
participant_type string Type of call participant.
Possible values: Agent, Customer
connection_type integer Indicator of the capacity in which the participant is involved in the call.
Possible values:
0: Indicates that the participant is involved in the call as a customer.
1: Indicates that the participant is involved in the call as a primary agent.
2 - 7: Invalid for onCallCreate.
call_status integer Indicator of the state of the call.
Default: 0
Possible values:
1: Answered/Completed
2: The call connection couldn’t be established as the number is busy.
3: The call falls under the category of a missed call.
4: The call connection failed.
5: The call connection is disconnected.
6: The call is routed to a queue.
8: The call is in progress.
9: The call is blocked.
10: The call is redirected to a voicemail.
11: The call originated from a restricted number.
12: The call is put on hold.
13: Establishing a call connection is in progress.
15: The call interaction was completed recently.
16: The voicemail recording is in progress.
duration integer This attribute is valid only after the completion of a call. Therefore, for onCallCreate this value is null.
duration_unit string Unit used to express duration.
Possible value: seconds
enqueued_time string This attribute is valid only in the case of the call being assigned to a queue. Therefore, for onCallCreate this value is null.
cost integer This attribute is valid only after the completion of the call. Therefore, for onCallCreate this value is null.
cost_unit string Currency in which cost is expressed, specified as a valid three character ISO currency code.
created_time string Timestamp of when the call participant object is created, specified in the UTC format.
updated_time string Timestamp of when the attributes of the call participant object are updated, specified in the UTC format.
onCallUpdate

When a call connection is established or lost, when a call’s status changes (transferred to an agent, an agent barges into a call, the call becomes a conference call, and so on), and when additional information such as call recording information, bill duration, call cost, call notes is associated with a call, the onCallUpdate event is triggered.

Register the onCallUpdate event by using the following sample manifest.json content.

Copied Copy 
1
2
3
4
5
"events": {
  "onCallUpdate": {
    "handler": "onCallUpdateCallback"
  }
}

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

Copied Copy 
1
2
3
4
5
exports = {
  onCallUpdateCallback: function(payload) {
    console.log("Logging arguments from onCallUpdateCallback event: " + JSON.stringify(payload));
  }
}
EXPAND ↓ Sample Payload 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
  "account_id": "82918",
  "domain": "sample.freshcaller.com",
  "event": "onCallUpdate",
  "timestamp": 1583839672,
  "region": "US",
  "data": {
    "call": {
      "phone_number": "+12133701559",
      "root_call_id": null,
      "created_time": "2020-03-10T09:07:00.000Z",
      "assigned_ivr_id": null,
      "assigned_team_id": null,
      "phone_number_id": 46851,
      "participants": [
        {
          "participant_type": "Customer",
          "duration": 0,
          "caller_number": "+12133701559",
          "created_time": "2020-03-10T09:07:00.000Z",
          "connection_type": 0,
          "enqueued_time": null,
          "cost_unit": "usd",
          "caller_id": 7994085,
          "duration_unit": "seconds",
          "id": 321,
          "cost": 0,
          "participant_id": 135,
          "updated_time": "2020-03-10T09:07:44.000Z",
          "call_id": 156,
          "call_status": 3
        },
        {
          "participant_type": "Agent",
          "duration": 9,
          "caller_number": null,
          "created_time": "2020-03-10T09:07:00.000Z",
          "connection_type": 1,
          "enqueued_time": null,
          "cost_unit": "usd",
          "caller_id": null,
          "duration_unit": "seconds",
          "id": 823,
          "cost": null,
          "participant_id": 694,
          "updated_time": "2020-03-10T09:07:09.000Z",
          "call_id": 156,
          "call_status": 1
        }
      ],
      "direction": "outgoing",
      "assigned_call_queue_id": null,
      "id": 156,
      "parent_call_id": null,
      "bill_duration": 9,
      "bill_duration_unit": "seconds",
      "updated_time": "2020-03-10T11:27:51.000Z",
      "call_notes": "Customer needs to cancel flight",
      "recording": null,
      "assigned_agent_id": 694
    },
    "associations": {},
    "actor": {
      "type": "system"
    },
    "changes": {}
  }
}
EXPAND ↓
Attributes of the data object
ATTRIBUTE TYPE DESCRIPTION
call call object Details pertaining to the call whose status change triggered the onCallUpdate event.
associations object All objects related to the call object.
For onCallUpdate, this value is an empty object.
actor actor object Information pertaining to the entity that updated the call object.
Attribute of the actor object:
type (string): Identifier of the entity that updated the call object. For onCallUpdate, this value is system.
changes object Changes that triggered the onCallUpdate event, specified as a JSON object of the following format:
1
2
3
{
“<call object field that changed>”: [“New value”, “Old value”]
}
For onCallUpdate, this value is an empty object.

Attributes of the call object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the call object, auto-generated when the object is created at the start of a call.
direction integer Direction of the call.
Possible values:
Incoming: The call whose details were updated was received at a Freshcaller number.
Outgoing: The call whose details were updated was made from a Freshcaller number.
parent_call_id integer For transferred calls, parent_call_id is the identifier of the parent call that is transferred to an agent or a team.
For non-transferred calls, the value is null.
root_call_id integer For child calls created because of events such as agent monitoring, root_call_id is the identifier of the source call.
For source calls, the value is null.
phone_number_id integer Identifier of the Freshcaller number from which the call is made or to which the call is received. The value is auto-generated when a number is configured in the Freshcaller system.
phone_number string Freshcaller number from which the call is made or to which the call is received.
assigned_agent_id integer Identifier of the primary agent who interacts with the customer.
assigned_team_id integer For inbound calls, assigned_team_id is the identifier of the team to which the call is assigned.
For outbound calls, the value is null.
assigned_call_queue_id integer For inbound calls, assigned_call_queue_id is the identifier of the call queue associated with the number in which the call is received. The call queue to which a call must be routed is specified when call actions are defined for a Freshcaller number.
For outbound calls, the value is null.
assigned_ivr_id integer For inbound calls, assigned_ivr_id is the identifier of the Interactive Voice Response (ivr) menu associated with the number in which the call is received . The ivr menu is associated with a number when call actions are defined for the number.
For outbound calls and for numbers that don’t have an ivr menu, the value is null.
call_notes string Notes entered by an agent during or after the call.
bill_duration integer Duration for which the cost associated with a call is calculated, specified in the unit defined by bill_duration_unit.
bill_duration_unit string Unit of time used to express bill_duration.
Possible value: seconds.
created_time string Timestamp of when the call is established, specified in the UTC format.
updated_time string Timestamp of when the attributes of a call are last updated, specified in the UTC format.
recording recording object This attribute is valid only on completion of a call. Therefore, for onCallCreate this value is null.
participants array of callparticipant objects Information about the agents and customer involved in the call.

Attributes of the callparticipant object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the callparticipant object, auto-generated when the callparticipant object is created (when a participant joins a call) in the Freshcaller system.
call_id integer Identifier of the call object, auto-generated when a call is initiated in the Freshcaller system.
caller_id integer Identifier of the customer number.
For the agent participant_type, the value is null.
caller_number string Customer's phone number from which the call is made or received.
participant_id integer Identifier of the participant, maybe an agent or a customer.
participant_type string Type of call participant.
Possible values (enum): Agent, Customer
connection_type integer Type of call connection the participant is involved in.
Possible values:
0: Indicates that the participant is involved in the call as a customer.
1: Indicates that the participant is involved in the call as a primary agent.
2: Indicates that the participant is involved in the call as an agent monitoring the call.
3: Indicates that the participant is involved in the call as an agent who has barged into the primary agent’s call.
4: Indicates that the participant is involved in the call as an agent to whom the call was transferred (cold transfer).
5: Indicates that the participant is involved in the call as an agent to whom the call was transferred after the primary agent provided relevant information (warm transfer).
6: Indicates that the participant is involved in the call as an agent in a conference call.
7: Indicates that the participant involved in the call is an agent who received the call in a number external to Freshcaller.
call_status integer Indicator of the state of the call.
Default: 0
Possible values:
1: Answered/Completed
2: The call connection couldn’t be established as the number was busy.
3: The call falls under the category of a missed call.
4: The call connection failed.
5: The call connection is disconnected.
6: The call is routed to a queue.
8: The call is in progress.
9: The call is blocked.
10: The call is redirected to a voicemail.
11: The call originated from a restricted number.
12: The call is put on hold.
13: The call connection is being established.
15: The call interaction was completed recently.
16: The voicemail recording is in progress.
duration integer Duration of the call, specified in a unit defined by duration_unit.
duration_unit string Unit used to express duration.
Possible value: seconds
enqueued_time string Time when the call is assigned to a queue, specified in UTC format.
cost integer Cost associated with the call, calculated based on bill_duration and the default pricing mechanism in Freshcaller.
cost_unit string Currency in which cost is expressed, specified as a valid three character ISO currency code.
created_time string Timestamp of when the call participant object is created, specified in the UTC format.
updated_time string Timestamp of when the attributes of the call participant object are updated, specified in the UTC format.
onAgentUpdate

The onAgentUpdate event is triggered and the registered callback method is executed, when:

  • The agent status is modified.
  • The agent signs in or out of the Freshcaller system.

Register the onAgentUpdate event by using the following sample manifest.json content.

Copied Copy 
1
2
3
4
5
"events": {
    "onAgentUpdate": {
        "handler": "onAgentUpdateCallback"
    }
}

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

Copied Copy 
1
2
3
4
5
exports= {
        onAgentUpdateCallback: function(payload){
            console.log("Logging arguments from onAgentUpdate event: "+ JSON.stringify(payload);
    }
}
 Sample Payload 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
{
    "region": "US",
    "account_id": "82918",
    "domain": "sample.freshcaller.com",
    "event": "onAgentUpdate",
    "timestamp": 1583839672,
    "version": "2.0",
    "data": {
        "agent": {
            "id": 787096,
            "created_at": "2021-12-10T12:51:59Z",
            "updated_at": "2022-08-30T08:05:50Z",
            "name": "omniagent one",
            "email": "sample@gmail.com",
            "account_id": 682861,
            "user_id": 856523,
            "status": 0,
            "preference": 0,
            "available_on": 0,
            "deleted": false,
            "teams": [
                {
                    "id": 301395,
                    "name": "group2"
                }
            ],
            "browser_status_id": 5642131,
            "browser_status_name": "Offline",
            "mobile_app_status_id": 5642131,
            "mobile_app_status_name": "Offline",
            "common_status_id": 5642131,
            "common_status_name": "Offline",
            "logged_in": false,
            "freshid_uuid": "sample_uuid",     
            "time_zone": "Etc/UTC",
            "last_seen_at": "2022-08-12T05:08:56Z",
            "last_call_at": "2022-08-12T05:08:56Z",
            "last_status_change_at": "2022-08-12T05:08:56Z",
        },
        "actor": {
            "id": 856523,
            "created_at": "2021-12-10T12:51:58Z",
            "updated_at": "2022-08-29T18:45:26Z",
            "account_id": 682861,
            "name": "omniagent one",
            "confirmed": true,
            "account_admin": true,
            "twitter_id": null,
            "facebook_id": null,
            "sign_in_count": 248,
            "current_sign_in_at": "2022-08-29T18:45:26Z",
            "last_sign_in_at": "2022-08-29T14:28:54Z",
            "language": null,
            "time_zone": "UTC",
            "phone": "",
            "mobile": null,
            "failed_attempts": 0,
            "locked_at": null,
            "deleted": false,
            "uuid": "389398835151017469",
            "freshid_uuid": "389398835151017469",
            "shared": false,
            "primary_email": {
            "id": 856514,
            "created_at": "2021-12-10T12:51:58Z",
            "updated_at": "2021-12-10T12:51:59Z"
            "account_id": 682861,
            "user_id": 856523,
            "email": "omniagentone@gmail.com",
            "confirmed": true,
            "primary_email": true,
            },
            "agent": {
                "id": 787096,
                "created_at": "2021-12-10T12:51:59Z",
                  "updated_at": "2022-08-30T08:05:50Z",
                  "name": "sample name",
                  "email": "sample@gmail.com",
                  "account_id": 682861,
                  "user_id": 856523,
                  "status": 0,
                  "preference": 0,
                  "available_on": 0,
                  "deleted": false,
                  "teams": [
                    {
                      "id": 301395,
                      "name": "group2"
                    }
                  ],
                  "browser_status_id": 5642131,
                  "browser_status_name": "Offline",
                  "mobile_app_status_id": 5642131,
                  "mobile_app_status_name": "Offline",
                  "common_status_id": 5642131,
                  "common_status_name": "Offline",
                  "logged_in": false,
                  "freshid_uuid": "389398835151017469",
                  "time_zone": "Etc/UTC",
                  "last_seen_at": "2022-08-12T05:08:56Z",
                  "last_call_at": "2022-08-12T05:08:56Z",
                  "last_status_change_at": "2022-08-12T05:08:56Z"
            }
        },
        "associations": {},
        "changes": {
            "model_changes": {
                "updated_at": [
                    "2022-08-29 18:45:26 UTC",
                    "2022-08-30 08:05:50 UTC"
                ]
            }
        }
    }
}
EXPAND ↓
Attributes of the data object
ATTRIBUTE TYPE DESCRIPTION
agent agent object Information pertaining to an agent whose details are modified in the Freshcaller system.
actor actor object Information pertaining to the entity (agent/ user) who triggered the onAgentUpdate event in the Freshcaller system.
associations actor object All associated objects of the agent object, which specify additional information pertaining to the agent.
changes object Changes that triggered the onAgentUpdate event, specified as a JSON object of the following format:
1
2
3
4
5
6
{
    "model_changes": {
        //For non-array attributes
        "<agent.attribute that changed>": ["Old value", "New value"]
    }
}
Example 
1
2
3
4
5
6
7
{
    model_changes": {
        "updated_at": [
            "2022-08-29 18:45:26 UTC",
            "2022-08-30 08:05:50 UTC"
        ]
}
 Attributes of the changes object:
model_changes (object): List of all attributes whose values have changed along with the old and modified values of the attributes.

Attributes of the agent object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the agent object, auto-generated when an agent’s information is configured in the Freshcaller system.
created_at string Timestamp of when the agent’s record is created in the Freshcaller system, specified in the UTC format.
updated_at string Timestamp of when the agent’s record is last updated in the Freshcaller system, specified in the UTC format.
account_id integer Identifier of the organization’s Freshcaller account, auto-generated when the account is configured.
name string Name of the agent
email string Email address of the agent.
user_id integer Identifier of the agent who is also added as a user in the Freshcaller system. All agents are also added as users in the Freshcaller system.
status integer Status of the agent, automatically set according to the status preference selected by the agent.
The default agent statuses and the corresponding agent.status values are,
0: Status selected is Offline or any custom status
1: Status selected is Online
2: Status selected is Busy or whenever the user is on a call.
3: Status is After Call Work (ACW) (the status is automatically selected as ACW after a call is disconnected and till the conversation widget is open).
Custom statuses such as Away, In a meeting, and so on, can be added in Freshcaller. The agent can upload these custom statuses when they are unavailable to receive or make a call. When an agent uploads the custom status as their availability status, then the value of status attribute is 0
preference integer Last availability status preference of the agent that is used to assign the current availability status, when the agent signs in to the Freshcaller account or concludes a call.
Possible values:
0: Offline and unavailable.
1: Available to take calls on the browser.
2: Available to take calls on the mobile.
available_on integer Medium in which the agent is available.
Possible values:
0: The agent is offline and unavailable to take calls.
1: The agent is available to take calls on the browser.
2: The agent is available to take calls on the mobile.
deleted boolean Specifies whether the agent record is deleted from the Freshcaller system.
Possible values: true, false
teams array of objects Details of the teams to which the agent is associated, specified as an array.
Attribute of the id object:
id (string): Identifier of the team object, auto-generated when a new team is configured in the Freshcaller system.
name (string): Name of the team.
browser_status_id integer Identifier of the agent status in the browser.
browser_status_name string Status of the agent in the browser.
mobile_app_status_id integer Identifier of the agent status in the mobile app.
mobile_app_status_name string Status of the agent in the mobile app.
common_status_id integer Identifier of the agent status determined based on the status set in both the browser and the mobile app.
common_status_name string Status of the agent, automatically set according to the status preference selected by the agent on the browser and the mobile app.
If the agent is available to take calls on either the browser or the mobile then the value of this attribute is set as Available.
Note: If the browser status is set as Forward to phone and the agent is available to take calls on mobile,the browser status takes precedence. In this case, the value of this attribute is set as Forward to phone.
logged_in boolean Specifies whether the agent is logged into the Freshcaller system.
Possible values: true, false
freshid_uuid string Universally unique identifier of the agent across Freshworks’ master record.
time_zone string Time zone to which the agent belongs, specified in the RAILS timezone.name format.
last_seen_at string Timestamp of when the agent was last active in the Freshcaller system, specified in the UTC format.
last_call_at string Timestamp of when the agent handled the previous call in the Freshcaller system, specified in the UTC format.
last_status_change_at string Timestamp of when the agent status was last modified in the Freshcaller system, specified in the UTC format.

Attributes of the actor object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the actor who triggered the product event.
For onAgentUpdate event, the value of this attribute is agent.user_id.
created_at string Timestamp of when the actor object is created in the Freshcaller system, specified in the UTC format.
updated_at string Timestamp of when the actor object is last updated in the Freshcaller system, specified in the UTC format.
account_id integer Identifier of the organization’s Freshcaller account, auto-generated when the account is configured.
name string Name of the actor.
For onAgentUpdate event, the value of this attribute is agent.name.
confirmed boolean Specifies whether the actor’s account is activated by accessing the activation email.
Possible values: true, false
account_admin boolean Specifies whether the actor is an account admin.
Possible values: true, false
twitter_id string Identifier of the actor’s twitter account.
facebook_id string Identifier of the actor’s facebook account.
sign_in_count integer Number of times the actor has signed in.
current_sign_in_at string Timestamp of when the actor signed in for the current session in the Freshcaller system, specified in the UTC format.
last_sign_in_at string Timestamp of when the actor previously signed in to the Freshcaller system, specified in the UTC format.
language string Preferred language selected by the actor when setting up the user profile.
time_zone string Time zone selected by the actor when setting up the user profile.
phone string Telephone number of the actor.
mobile string Mobile number of the actor.
failed_attempts integer 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 Freshcaller account.
locked_at string Timestamp of when the actor was blocked from accessing the Freshcaller system due to multiple failed login attempts, specified in the UTC format.
deleted boolean Specifies whether the actor’s information is deleted from the Freshcaller system.
Possible values: true, false
uuid string Unique user identifier, this value is auto-generated.
freshid_uuid string Universally unique identifier of the agent across Freshworks’ master record.
primary_email primary email object Information pertaining to the primary email of the actor.
agent agent object Information pertaining to an agent whose details were updated.

Attributes of the primary email object
ATTRIBUTE TYPE DESCRIPTION
id integer Identifier of the primary email object, auto-generated when the agent’s primary email is configured in the Freshcaller system.
created_at string Timestamp of when the primary email object is created in the Freshcaller system, specified in the UTC format.
updated_at string Timestamp of when the primary email object is last updated in the Freshcaller system, specified in the UTC format.
account_id integer Identifier of the organization’s Freshcaller account, auto-generated when the account is configured.
user_id integer Identifier of the agent who is also added as a user in the Freshcaller system. All agents are also added as users in the Freshcaller system.
email string Primary email address of the agent.
confirmed boolean Specifies whether the agent’s account is activated by accessing the activation email.
Possible values: true, false
primary_email boolean Specifies whether the email is a primary email.
Possible values: true, false
For onAgentUpdate event, the value of this attribute is true.
Test

For information on how to simulate a product event and test your app, see Test the app.