Webhook Payload
Headers
X-Retry-Count - String
X-Freshchat-Payload-Version - String
X-Freshchat-Signature - String
Events
- message_create
- conversation_assignment
- conversation_resolution
- conversation_reopen
actor_type - user, agent, system
Message_type - normal, private
1. message_create
{
"actor": {
"actor_type": "agent",
"actor_id": "1b8d2418-89a3-4de6-b93c-9f6557f13d04"
},
"action": "message_create",
"action_time": "2022-11-22T10:55:23.126Z",
"data": {
"message": {
"message_parts": [
{
"text": {
"content": "হাই সেখানে! আমি আজ তোমার জন্য কি করতে পারি?"
}
}
],
"app_id": "c6ec783e-4c89-490a-bbbc-32c97e2a8c3d",
"actor_id": "1b8d2418-89a3-4de6-b93c-9f6557f13d04",
"id": "a834cd45-c463-4644-b254-be920924a998",
"channel_id": "304d0a73-5135-4be6-9df3-7a4aa2a0d855",
"conversation_id": "35e80ec8-c697-42e4-8ce9-a47a050b1d1a",
"interaction_id": "681406910844650-1669114522220",
"actor_type": "agent",
"created_time": "2022-11-22T10:55:23.126Z",
"user_id": "9047e655-1e83-463e-b1b6-4a44beb1f07f",
"restrictResponse": false,
"botsPrivateNote": false
}
}
}2. conversation_reopen
{
"actor": {
"actor_type": "user",
"actor_id": "9047e655-1e83-463e-b1b6-4a44beb1f07f"
},
"action": "conversation_reopen",
"action_time": "2022-11-22T10:55:22.272Z",
"data": {
"reopen": {
"reopener": "user",
"reopener_id": "9047e655-1e83-463e-b1b6-4a44beb1f07f",
"conversation": {
"conversation_id": "35e80ec8-c697-42e4-8ce9-a47a050b1d1a",
"app_id": "c6ec783e-4c89-490a-bbbc-32c97e2a8c3d",
"status": "reopened",
"channel_id": "304d0a73-5135-4be6-9df3-7a4aa2a0d855",
"skill_id": 0,
"sla_policy_id": 0,
"sla_breached": false
},
"interaction_id": "681406910844650-1669114522220"
}
}
}3. conversation_resolution
{
"actor": {
"actor_type": "agent",
"actor_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370"
},
"action": "conversation_resolution",
"action_time": "2022-11-22T10:54:42.298Z",
"data": {
"resolve": {
"resolver": "agent",
"resolver_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370",
"conversation": {
"conversation_id": "35e80ec8-c697-42e4-8ce9-a47a050b1d1a",
"app_id": "c6ec783e-4c89-490a-bbbc-32c97e2a8c3d",
"status": "resolved",
"channel_id": "304d0a73-5135-4be6-9df3-7a4aa2a0d855",
"skill_id": 0,
"sla_policy_id": 0,
"sla_breached": false
},
"interaction_id": "681406910844650-1669114480262",
"user": {
"properties": [
{
"name": "fc_user_timezone",
"value": "Asia/Calcutta"
}
],
"created_time": "2022-11-22T10:51:48.696Z",
"updated_time": "2022-11-22T10:52:01.119Z",
"id": "9047e655-1e83-463e-b1b6-4a44beb1f07f",
"first_name": "Friendly Pizza",
"avatar": {
"url": "https://s3.amazonaws.com/fresh-chat-names/img/pizza.png"
},
"login_status": false
}
}
}
}4. conversation_assignment
{
"actor": {
"actor_type": "agent",
"actor_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370"
},
"action": "conversation_assignment",
"action_time": "2022-11-23T10:33:32.836Z",
"data": {
"assignment": {
"assignor": "agent",
"assignor_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370",
"to_agent_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370",
"to_group_id": "bea0f66b-0961-4aee-af1d-19a069f96467",
"from_agent_id": "",
"from_group_id": "bea0f66b-0961-4aee-af1d-19a069f96467",
"conversation": {
"conversation_id": "4424a18a-f624-4a1f-8800-c36356a64e5c",
"app_id": "c6ec783e-4c89-490a-bbbc-32c97e2a8c3d",
"status": "assigned",
"channel_id": "cde9ec2b-c462-45db-a873-1975cac7b1f2",
"assigned_agent_id": "fc2d90bc-688b-46bc-a5f0-bcd60b7c2370",
"assigned_org_agent_id": "380337516777740852",
"assigned_group_id": "bea0f66b-0961-4aee-af1d-19a069f96467",
"skill_id": 0,
"sla_policy_id": 0,
"sla_breached": false
},
"interaction_id": "677057091615181-1668052341499"
}
}
}Note: Either from_agent_id and to_agent_id will be populated, or from_group_id and to_group_id will be populated.
Normal message from agent:
{
"actor": {
"actor_type": "agent",
"actor_id": "ae72b467-a0d2-43a6-a1c7-8cf33d68c7c4"
},
"action": "message_create",
"action_time": "2020-04-06T15:59:44.725Z",
"data": {
"message": {
"message_parts": [
{
"text": {
"content": "Hi!!! Agent this side"
}
}
],
"app_id": "87f6d88a-3921-4515-8acf-18fe4d2b4149",
"actor_id": "ae72b467-a0d2-43a6-a1c7-8cf33d68c7c4",
"id": "35814612-97f6-43bb-9266-cf6cd7cf6a0e",
"channel_id": "c5456f9e-9131-43aa-b3ec-29535bc7691d",
"conversation_id": "aecf3cc7-138a-4b40-9723-5bf4d1abb97b",
"message_type": "normal",
"actor_type": "agent",
"created_time": "2020-04-06T15:59:44.709Z",
"user_id": "5cac723a-13aa-473e-846b-9cdb7d2c41a5",
"message_source": "web"
}
}
}Private note from Agent:
{
"actor": {
"actor_type": "agent",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e"
},
"action": "message_create",
"action_time": "2020-04-07T13:26:27.646Z",
"data": {
"message": {
"message_parts": [
{
"text": {
"content": "This customer is also reaching out through email, follow up on both the ends."
}
}
],
"app_id": "c2bf4b15-38c5-49d1-b0d5-a2b86caac2b7",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"id": "2c22af23-41bb-431d-a906-efe33a7294c6",
"channel_id": "8dfdec10-1c12-48d6-9889-40fba30daefa",
"conversation_id": "40c15ddf-74e0-41e5-870e-69187d085778",
"message_type": "private",
"actor_type": "agent",
"created_time": "2020-04-07T13:26:27.625Z",
"user_id": "a6ef2b6b-3fda-497e-bf3e-560b6f9612cd",
"message_source": "web"
}
}
}Message from User:
{
"actor": {
"actor_type": "user",
"actor_id": "5cac723a-13aa-473e-846b-9cdb7d2c41a5"
},
"action": "message_create",
"action_time": "2020-04-06T15:59:29.981Z",
"data": {
"message": {
"message_parts": [
{
"text": {
"content": "User here, I am going"
}
}
],
"app_id": "87f6d88a-3921-4515-8acf-18fe4d2b4149",
"actor_id": "5cac723a-13aa-473e-846b-9cdb7d2c41a5",
"id": "ae46748d-daea-44ae-bd41-11eb4797853d",
"channel_id": "c5456f9e-9131-43aa-b3ec-29535bc7691d",
"conversation_id": "aecf3cc7-138a-4b40-9723-5bf4d1abb97b",
"message_type": "normal",
"actor_type": "user",
"created_time": "2020-04-06T15:59:29.971Z",
"message_source": "web"
}
}
}System Message (Business Hour Away message):
{
"actor": {
"actor_type": "agent",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e"
},
"action": "message_create",
"action_time": "2020-04-07T13:23:05.351Z",
"data": {
"message": {
"message_parts": [
{
"text": {
"content": "We are away now"
}
}
],
"app_id": "c2bf4b15-38c5-49d1-b0d5-a2b86caac2b7",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"id": "5ea7ea3d-5bb3-4f78-8e11-15cad506b213",
"channel_id": "8dfdec10-1c12-48d6-9889-40fba30daefa",
"conversation_id": "40c15ddf-74e0-41e5-870e-69187d085778",
"actor_type": "agent",
"created_time": "2020-04-07T13:23:05.328Z",
"user_id": "a6ef2b6b-3fda-497e-bf3e-560b6f9612cd",
"message_source": "system"
}
}
}Conversation Assignment to Agent:
{
"actor": {
"actor_type": "agent",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e"
},
"action": "conversation_assignment",
"action_time": "2020-04-07T13:35:18.622Z",
"data": {
"assignment": {
"assignor": "agent",
"assignor_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"to_agent_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"to_group_id": "f8552a49-e96d-400f-bea0-add54b5ba6fc",
"from_agent_id": "",
"from_group_id": "f8552a49-e96d-400f-bea0-add54b5ba6fc",
"conversation": {
"conversation_id": "40c15ddf-74e0-41e5-870e-69187d085778",
"app_id": "c2bf4b15-38c5-49d1-b0d5-a2b86caac2b7",
"status": "assigned",
"channel_id": "8dfdec10-1c12-48d6-9889-40fba30daefa",
"assigned_agent_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"assigned_group_id": "f8552a49-e96d-400f-bea0-add54b5ba6fc"
}
}
}
}
Conversation Assignment to Group:
{
"actor": {
"actor_type": "agent",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e"
},
"action": "conversation_assignment",
"action_time": "2020-04-07T13:35:16.800Z",
"data": {
"assignment": {
"assignor": "agent",
"assignor_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"to_agent_id": "",
"to_group_id": "f8552a49-e96d-400f-bea0-add54b5ba6fc",
"from_agent_id": "",
"from_group_id": "",
"conversation": {
"conversation_id": "40c15ddf-74e0-41e5-870e-69187d085778",
"app_id": "c2bf4b15-38c5-49d1-b0d5-a2b86caac2b7",
"status": "new",
"channel_id": "8dfdec10-1c12-48d6-9889-40fba30daefa",
"assigned_group_id": "f8552a49-e96d-400f-bea0-add54b5ba6fc"
}
}
}
}Agent Resolves a Conversation:
{
"actor": {
"actor_type": "agent",
"actor_id": "ae72b467-a0d2-43a6-a1c7-8cf33d68c7c4"
},
"action": "conversation_resolution",
"action_time": "2020-04-06T15:59:46.407Z",
"data": {
"resolve": {
"resolver": "agent",
"resolver_id": "ae72b467-a0d2-43a6-a1c7-8cf33d68c7c4",
"conversation": {
"conversation_id": "aecf3cc7-138a-4b40-9723-5bf4d1abb97b",
"app_id": "87f6d88a-3921-4515-8acf-18fe4d2b4149",
"status": "resolved",
"channel_id": "c5456f9e-9131-43aa-b3ec-29535bc7691d"
}
}
}
}Agent reopens a Conversation:
{
"actor": {
"actor_type": "agent",
"actor_id": "999abdc6-e4b1-4944-a246-86f63109df7e"
},
"action": "conversation_reopen",
"action_time": "2020-04-07T13:28:49.194Z",
"data": {
"reopen": {
"reopener": "agent",
"reopener_id": "999abdc6-e4b1-4944-a246-86f63109df7e",
"conversation": {
"conversation_id": "40c15ddf-74e0-41e5-870e-69187d085778",
"app_id": "c2bf4b15-38c5-49d1-b0d5-a2b86caac2b7",
"status": "reopened",
"channel_id": "8dfdec10-1c12-48d6-9889-40fba30daefa"
}
}
}
}User reopens a Conversation:
{
"actor": {
"actor_type": "user",
"actor_id": "5cac723a-13aa-473e-846b-9cdb7d2c41a5"
},
"action": "conversation_reopen",
"action_time": "2020-04-06T15:59:50.314Z",
"data": {
"reopen": {
"reopener": "user",
"reopener_id": "5cac723a-13aa-473e-846b-9cdb7d2c41a5",
"conversation": {
"conversation_id": "aecf3cc7-138a-4b40-9723-5bf4d1abb97b",
"app_id": "87f6d88a-3921-4515-8acf-18fe4d2b4149",
"status": "reopened",
"channel_id": "c5456f9e-9131-43aa-b3ec-29535bc7691d"
}
}
}
}Authentication
All calls to your webhook will have the header X-Freshchat-Signature. You can verify the signature using the provided public key to authenticate the webhook calls.
Given below is an example code snippet to authenticate webhook calls implemented in Java:
// in some languages you will need to trim out "--BEGIN PRIVATE KEY--" and "--END
PRIVATE KEY--" parts
public static PublicKey loadPublicKey(String publicKeyString) throws Exception {
byte [ ] data = Base64.getDecoder().decode(publicKeyString);
X509EncodedKeySpec spec = new X509EncodedKeySpec(data);
KeyFactory fact = KeyFactory.getInstance(RSA);
return fact.generatePublic(spec);
}
// pass the publicKey from above to this method, with signature and plaintext is webhook payload
// to verify if the payload and signature matches
public static boolean verify(String plainText, String signature, PublicKey publicKey)
throws Exception {
Signature publicSignature = Signature.getInstance( "SHA256withRSA" );
publicSignature.initVerify(publicKey);
publicSignature.update(plainText.getBytes(UTF_8));
byte [ ] signatureBytes = Base64.getDecoder().decode(signature);
return publicSignature.verify(signatureBytes);Given below is an example code snippet to authenticate webhook calls implemented in Ruby:
key_from_settings = <public key from webhooks tile in settings page>
@rsa = OpenSSL::PKey::RSA.new(key_from_settings)
signature = Base64.decode64(@header['HTTP_X_FRESHCHAT_SIGNATURE']) # from webhook
algorithm = OpenSSL::Digest::SHA256.new
# the payload is the webhook json payload received.
payload_verification = @rsa.verify(algorithm, signature, @payload.to_json.to_s)
expect(payload_verification).to be(true)For a detailed description of the signing and encryption logic, refer to https://niels.nu/blog/2016/java-rsa.html.