Kategoriler

Documentation

Webhook API

JivoChat sisteminde ziyaretçiler ile ilgili çeşitli etkinlikler hakkında bildirim almak için Webhookları (Web Kancaları) kullanın. Uygulamanızda, ilgili kanal ayarlarında, Geliştiriciler için Entegrasyon Ayarları kısmında, bir olay gerçekleştiğinde istek göndermek için bir HTTP(S) URL’si belirleyebilirsiniz.

POST isteği, JSON nesnesindeki olay bilgileriyle birlikte bir gövde olarak belirtilen URL’ye gönderilir.

Olay türü, 'event' yapısının event_name alanında belirtilir. Olaya bağlı olarak diğer bazı alanlar da iletilir.

Bazı olay türlerinde, HTTP talebine yanıt olarak, sohbeti kabul eden temsilciye görüntülenecek veriler de gönderebilirsiniz. Bu, CRM bağlantıları için elzemdir.

call_event#

Temsilcilere yeni arama geldiğinde veya mevcut aramada değişiklik olduğunda gönderilir.

Örnek:


{
    "event_name": "call_event",
    "chat_id": 4398,
    "widget_id": "2853",
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "number": "2746",
        "description": "Description text",
        "social": {},
        "chats_count": 8
    },
    "agent": {
        "id": "3599",
        "name": "Thomas Anderson",
        "email": "agent@jivosite.com",
        "phone": "+14083682346"
    },
    "department": {
        "id": 181,
        "name": "Sales"
    },
    "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "call": {
        "type": "callback",
        "phone": "+14084987855",
        "status": "end",
        "record_url": "http://example.com/record.mp3"
    },
    "analytics": {}
}

chat_accepted#

Temsilci gelen sohbet talebinde ‘Kabul Et’e bastığında iletilir. Ziyaretçi hakkında bilinen tüm bilgi ve bazı temsilci bilgileri değişkenler ile iletilir. Ayrıca jivo_api.setUserToken kullanılırsa, atanmış ziyaretçi numarası da iletilir. [setUserToken].

chat_accepted olayına verilen yanıt contact_info'yu içeriyorsa, bu veri temsilciye tıpkı ziyaretçi iletişim formunu doldurmuşçasına gösterilir. Ayrıca sohbet günlüğüne kaydedilecektir.

Örnek:


{
    "event_name": "chat_accepted",
    "widget_id": "3948",
    "user_token": null,
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "description": "Description text",
        "number": "2198",
        "social": {},
        "chats_count": 1
    },
    "organization": {
      "id": "1",
      "name": "Company name"
    },
    "status": {
      "id": "4",
      "title": "contact_later"
    },
    "assigned_agent": {
      "id": 1,
      "email": "agent1@gmail.com",
      "name": "Agent"
    },
    "tags": [
    {
      "id": "17",
      "title": "Tag example"
    }
  ],
    "chat_id": 7636,
    "department": {
        "id": 281,
        "name": "Sales"
    },
    "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "analytics": {},
    "agent": {
        "id": "2016",
        "name": "Thomas Anderson",
        "email": "agent@jivosite.com",
        "phone": "+14083682346"
    },
}

Yanıt Parametreleri

Alan Adı	Tür	Açıklama
result	string	Sonuça dair açıklama. Eğer değer “OK” değilse, veri temsilciye iletilmez
custom_data	array	Ek veri alanları, setCustomData ile benzer
contact_info	object	İletişim bilgileri alanları, setContactInfo ile benzer
enable_assign	boolean	Ziyaretçiyi CRM’de kaydetmek için temsilciye buton gösterilip gösterilmeyeceğini belirleyen bayrak. Buton, custom_data’da tüm alanların önünde görüntülenir.
crm_link	string fields	Ziyaretçinin CRM’deki kartının linki. Temsilciye custom_data’da tüm alanların altında ayrı bir buton olarak gösterilir.
page	object	Talebin oluştuğu sayfanın URLsi

custom_data

Alan Adı	Tür	Açıklama
title	string	Özelleştirilmiş alanın başlığı
content	string	Özelleştirilmiş alanın içeriği

contact_info

Alan Adı	Tür	Açıklama
name	string	Ziyaretçinin adı
phone `opsiyonel`	string	Ziyaretçinin telefonu
email `opsiyonel`	string	Ziyaretçinin e-postası

page

Alan Adı	Tür	Açıklama
url	string	Ziyaretçinin bulunduğu URL adresi
title `opsiyonel`	string	Ziyaretçinin bulunduğu sayfanın başlığı

Örnek:


 {
    "result": "ok",
    "custom_data": [
        {
            "title": "Title",
            "content": "Content text"
        }
    ],
    "contact_info": {
        "name": "John Smith",
        "phone": "+14084987855",
        "email": "email@example.com"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    }
}

chat_assigned#

Bir sohbet, "crm_link" parametresi kullanılarak chat_accepted olayına gönderilen yanıt sonucunda CRM'ye bağlandığında bu olay gönderilir. Ziyaretçi hakkında bilinen tüm veriler ve bazı temsilci bilgileri istek parametrelerinde gönderilecektir. Ayrıca, setUserToken kullanılarak ziyaretçinin kimliği de dahil olmak üzere parametreler widget'a gönderilmişse, bunlar da iletileceektir.

Örnek:


{
    "event_name": "chat_assigned",
    "widget_id": "3948",
    "user_token": null,
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "number": "2198",
        "description": "Description text",
        "social": {},
        "chats_count": 1
    },
    "organization": {
       "id": "1",
       "name": "Company name"
     },
     "status": {
       "id": "4",
       "title": "contact_later"
     },
     "assigned_agent": {
       "id": 1,
       "email": "agent1@gmail.com",
       "name": "Agent"
     },
     "tags": [],
     "chat_id": 1207,
     "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "analytics": {},
    "agent": {
        "id": "2016",
        "name": "Thomas Anderson",
        "email": "agent@jivosite.com",
        "phone": "+14083682346"
    },
    "assign_to": "https://test-crm.com",
}

Yanıt Parametreleri

Cevap olarak JSON {"result": "ok"} ya da bir hata mesajı beklenir.

Örnek:


{
    "result": "ok"
}

chat_updated#

Ziyaretçinin iletişim bilgileri güncellendiğinde gönderilecek olay – örneğin ziyaretçi sohbet esnasında iletişim bilgileri formunu doldurursa. Ziyaretçi hakkında bilinen tüm bilgi ve bazı temsilci bilgileri değişkenler ile iletilir. Ayrıca, setUserToken kullanılarak ziyaretçinin kimliği de dahil olmak üzere parametreler widget'a gönderilmişse, bunlar da iletileceektir.

Örnek:


{
    "event_name": "chat_updated",
    "widget_id": "3948",
    "user_token": null,
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "description": "Description text",
        "number": "2198",
        "chats_count": 1
    },
    "organization": {
      "id": "2",
      "name": "Company name"
    },
    "status": {
      "id": "4",
      "title": "contact_later"
    },
    "assigned_agent": null,
    "tags": [
      {
        "id": "7",
        "title": "Discount"
      }
    ],
    "chat_id": 7507,
    "department": {
        "id": 281,
        "name": "Sales"
    },
    "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "analytics": {},
    "agent": {
        "id": "2016",
        "name": "Thomas Anderson",
        "email": "agent@jivosite.com",
        "phone": "+14083682346"
    },
}

Yanıt Parametreleri

Alan Adı	Tür	Açıklama
result	string	Sonuça dair açıklama. Eğer değer “OK” değilse, veri temsilciye iletilmez
custom_data	array	Ek veri alanları, setCustomData ile benzer
contact_info	object	İletişim bilgileri alanları, setContactInfo ile benzer
enable_assign	boolean	Ziyaretçiyi CRM’de kaydetmek için temsilciye buton gösterilip gösterilmeyeceğini belirleyen bayrak. Buton, custom_data’da tüm alanların önünde görüntülenir
crm_link	string fields	Ziyaretçinin CRM’deki kartının linki. Temsilciye custom_data’da tüm alanların altında ayrı bir buton olarak gösterilir.
page	object	Talebin oluştuğu sayfanın URLsi

client_updated#

Olay, bir müşteriye ait veri güncellemesiyle tetiklenir. Örneğin, müşteriye bir temsilci atandı veya müşterinin kategorisi değiştirildi. Bu etkinlik aynı zamanda müşterinin iletişim bilgileri aktif bir sohbetten (CRM bölümünde - Müşteriler) güncellendiğinde de gönderilir.

Örnek:


{
  "event_name": "client_updated",
  "widget_id": "12345678",
  "user_token": null,
  "visitor": {
    "name": "Thomas",
    "email": "thomas@gmail.com",
    "phone": "+458745457845",
    "description": "Description text",
    "number": 1217,
    "chats_count": 1
  },
  "organization": {
    "id": "1",
    "name": "Company name"
  },
  "status": {
    "id": "4",
    "title": "contact_later"
  },
  "assigned_agent": {
    "id": 3,
    "email": "agent3@gmail.com",
    "name": "Agent3"
  },
  "tags": [
    {
      "id": "17",
      "title": "Sales"
    }
  ],
  "client_id": "1217"
}

Yanıt Parametreleri

Cevap olarak JSON {"result": "ok"} ya da bir hata mesajı beklenir.

Örnek:


{
    "result": "ok"
}

chat_finished#

Temsilci, uygulama sohbeti terkettiğinde gönderilen olay. Ziyaretçi hakkında bilinen tüm bilgi, sohbet kaydı ve bazı temsilci bilgileri değişkenler ile iletilir. Ayrıca, setUserToken kullanılarak ziyaretçinin kimliği de dahil olmak üzere parametreler widget'a gönderilmişse, bunlar da iletileceektir.

Örnek:


{
    "event_name": "chat_finished",
    "widget_id": "3948",
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "description": "Description text",
        "number": "2198",
        "chats_count": 2
    },
    "organization": null,
    "status": null,
    "assigned_agent": null,
    "tags": [],
    "chat_id": 7607,
    "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "analytics": null,
    "agents": [
        {
            "id": "2016",
            "name": "Thomas Anderson",
            "email": "agent@jivosite.com",
            "phone": "+14083682346"
        }
    ],
    "chat": {
      "messages": [
        {
          "message": "<Message text is not displayed here>",
          "timestamp": 1665396476,
          "type": "visitor"
        },
        {
          "message": "<Message text is not displayed here>",
          "timestamp": 1665396483,
          "type": "agent",
          "agent_id": 1
        }
      ],
        "blacklisted": false,
        "rate": null
    },
    "plain_messages": "",
    "html_messages": ""
}

Yanıt Parametreleri

Cevap olarak JSON {"result": "ok"} ya da bir hata mesajı beklenir.

Örnek:


{
    "result": "ok"
}

offline_message#

Ziyaretçi çevrimdışı iletişim formu ile bir mesaj gönderdiğinde gönderilecek olay. Ziyaretçi hakkında bilinen tüm bilgi ve çevrimdışı mesaj değişkenler ile iletilir. Ayrıca, setUserToken kullanılarak ziyaretçinin kimliği de dahil olmak üzere parametreler widget'a gönderilmişse, bunlar da iletileceektir.

Örnek:


{
    "event_name": "offline_message",
    "widget_id": "3948",
    "user_token": null,
    "visitor": {
        "name": "John Smith",
        "email": "email@example.com",
        "phone": "+14084987855",
        "description": "Description text",
        "number": "2198",
        "chats_count": 1
    },
    "organization": null,
    "status": null,
    "assigned_agent": null,
    "tags": [],
    "chat_id": 2026,
    "session": {
        "geoip": {
            "region_code": "CA",
            "country": "United States",
            "country_code": "US",
            "region": "California",
            "city": "San Francisco",
            "latitude": "37.7898",
            "longitude": "-122.3942",
            "organization": "Wikimedia Foundation"
        },
        "utm": "source=google|medium=cpc|content=banner|campaign=campaign_name",
        "utm_json": {
            "source": "google",
            "campaign": "campaign_name",
            "content": "banner",
            "medium": "cpc",
            "term": "..."
        },
        "ip_addr": "208.80.152.201",
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36"
    },
    "page": {
        "url": "http://example.com/",
        "title": "Page title"
    },
    "analytics": {},
    "message": "Message text",
    "offline_message_id": 1665399500726
}

Yanıt Parametreleri

Cevap olarak JSON {"result": "ok"} ya da bir hata mesajı beklenir.

Örnek:


{
    "result": "ok"
}

Olay Parametreleri#

event

Olay adı	Tür	Açıklama
event_name	string	Olay türü
widget_id	string	Sohbetin geldiği kanala ait widget id. Sohbet kodunda bulunabilir
user_token	string	Bir kullanıcının ek kimliği (setUserToken yöntemi kullanılarak ayarlanabilir)
visitor	object	Ziyaretçi hakkında bilgi içeren obje
organization	object	Müşterinin atanmış olduğu firma hakkında bilgi içeren obje
status	object	Müşterinin kategorisi
assigned_agent	object	Müşteriye atanmış temsilciye dair bilgi
tags	object	Müşteriye atanmış etiketler
chat_id	number	Sohbetin ID'si
department `opsiyonel`	object	Ziyaretçinin seçtiği departman hakkında bilgi içeren obje
session	object	Ziyaretçi oturumu hakkında bilgi içeren obje
page	object	Talebin oluştuğu sayfanın URLsi
call	object	Çağrı hakkında bilgi içeren obje
analytics `opsiyonel`	object	Analitiği
agent	object	Temsilci hakkında bilgi içeren obje
chat	object	Sohbet mesajları günlüğü

visitor

Alan Adı	Tür	Açıklama
name `opsiyonel`	string	Ziyaretçinin adı
email `opsiyonel`	string	Ziyaretçinin e-posta adresi
phone `opsiyonel`	string	Ziyaretçinin telefon numarası
description	string	Ziyaretçi hakkında ek bilgi
number	string	Ziyaretçi numarası
social `opsiyonel`	object	Ziyaretçinin sosyal ağ profilleri bilgisi
chats_count	number	Ziyaretçinin sohbet sayısı

organization

Alan Adı	Tür	Açıklama
id	number	Şirket ID'si
name	string	Şirket adı

status

Alan Adı	Tür	Açıklama
id	number	Müşteri kategori ID'si
title	string	Kategori adı

assigned_agent

Alan Adı	Tür	Açıklama
id	number	Atanmış temsilci ID'si
email	string	Atanmış temsilci e-postası
name	string	Atanmış temsilci adı

tags

Alan Adı	Tür	Açıklama
id	number	Etiket ID
title	string	Etiket adı

department

Alan Adı	Tür	Açıklama
id	number	Departman ID
name	string	Departman adı

session

Alan Adı	Tür	Açıklama
geoip	object	Coğrafi IP verisi
utm	string	String formatında UTM bilgisi
utm_json	object	json formatında UTM bilgisi
ip_addr	string	Ziyaretçinin IP adresi
user_agent	string	Ziyaretçinin tarayıcı bilgisi

page

Alan Adı	Tür	Açıklama
url	string	Ziyaretçinin bulunduğu URL adresi
title `opsiyonel`	string	Ziyaretçinin bulunduğu sayfanın başlığı

agent

Alan Adı	Tür	Açıklama
id	int	Temsilciye ait ID
name	string	Temsilci adı
email	string	Temsilci e-postası
phone `opsiyonel`	string	Temsilci telefon numarası

call

Alan Adı	Tür	Açıklama
type	string	Çağrı tipi: callback, incoming, outgoing (geri-arama, gelen, giden)
phone	string	Ziyaretçinin telefon numarası
status	string	Çağrı durumu: start, end, agent_connected, client_connected, error (başladı, bitti, temsilci bağlandı, ziyaretçi bağlandı, hata)
reason `opsiyonel`	string	Hata sebebi (eğer hata varsa)
record_url `opsiyonel`	string	Çağrının mp3 kaydına link (eğer çağrı bitmişse)

chat

Alan Adı	Tür	Açıklama
messages	object	Sohbet kaydını içeren obje
blacklisted	boolean	Ziyaretinin temsilci tarafından engellendiğini gösterir
rate `optional`	string	Sohbetin ziyaretçi tarafından değerlendirmesi
invitation `optional`	string	Akıllı tetikleyici metni

messages

Alan Adı	Tür	Açıklama
message	string	Mesaj metni
timestamp	int	Zaman etiketi-ts formatında
type	string	Kullanıcı türü(temsilci-ziyaretçi)
agent_id	number	Mesajı gönderen temsilcinin ID'si

geoip

Alan Adı	Tür	Açıklama
region_code	string	Bölge kodu
country_code	string	ISO ülke kodu
country	string	Ülke kodu
region	string	Bölge
city	string	Şehir
latitude	string	Enlem
longitude	string	Boylam
organization	string	İSS Şirket adı

utm_json

Alan Adı	Tür	Açıklama
source `opsiyonel`	string	utm_source değeri
campaign `opsiyonel`	string	utm_campaign değeri
content `opsiyonel`	string	utm_content değeri
medium `opsiyonel`	string	utm_medium değeri
term `opsiyonel`	string	utm_term değeri

CRM Webhooks API#

Webhook API'sine CRM bölümünde yapılan ekleme ve düzenleme işlemlerine dair etkinlikler eklendi.

Olay verisi isteklerinin gönderileceği sunucu adresi 'Müşteri Süreçleri' bölümü -> 'CRM Webhookları' alanında yapılandırılır. İstek POST yöntemi kullanılarak gönderilir ve istek gövdesi JSON formatında iletilir.

Etkinlik kategorisi (değişiklik içeren CRM varlığı) event_type alanı tarafından belirlenir. Eylemin türü (ekleme, değiştirme, silme), event_name alanının değerine göre belirlenebilir.

Pipeline (crm_pipeline)#

Bu olay 'Müşteri Süreçleri'- 'Süreçler' bölümüne yeni bir süreç eklenirken veya mevcutlardan birinini ayarları değiştirilirken gönderilir.

Olası olay türleri:

created_pipeline -yeni bir süreç oluşturulduğunda gönderilen olay
updated_pipeline - mevcut bir süreç düzenlendiğinde(aşamalar,başarısızlık sebepleri, para birimi düzenlemeleri) gönderilen olay
deleted_pipeline - mevcut bir süreç silindiğinde gönderilen olay

Örnek:


{
	"site_id": 464056,
	"event_type": "crm_pipeline",
	"event": {
		"event_name": "created_pipeline",
		"pipeline_id": 6,
		"title": "Gruzly",
		"currency": "TRY",
		"pipeline_statuses": [
			{
				"pipeline_status_id": 19,
				"title": "completed",
				"position": 0,
				"color": "0ed16a",
				"type": "system",
				"final_status": "successful"
			},
			{
				"pipeline_status_id": 20,
				"title": "unsuccessful",
				"position": 0,
				"color": "76869d",
				"type": "system",
				"final_status": "unsuccessful"
			},
			{
				"pipeline_status_id": 21,
				"title": "New",
				"position": 1,
				"color": "1fb6fd",
				"type": "user",
				"final_status": null
			}
		],
		"pipeline_reject_reasons": [
			{
				"pipeline_reject_reason_id": 21,
				"title": "Too expensive",
				"position": 0
			},
			{
				"pipeline_reject_reason_id": 22,
				"title": "Missed opportunity",
				"position": 1
			},
			{
				"pipeline_reject_reason_id": 23,
				"title": "Unacceptable terms",
				"position": 2
			},
			{
				"pipeline_reject_reason_id": 24,
				"title": "Chose another option",
				"position": 3
			}
		]
	}
}

Olay Parametreleri

Parametre adı	Tür	Açıklama
pipeline_id	number	Süreç ID'si
title	string	Süreç adı
currency	string	Uluslararası para birimi kodu
pipeline_statuses	array	Süreç aşamaları hakkında bilgi içeren dizi
pipeline_status_id	number	Aşama ID'si
title	string	Aşama adı
position	number	Sıra numarası (aşamanın listedeki konumu)
color	string	Öğe rengi (HEX biçiminde belirtilir)
type	string	Aşamayı kimin eklediği hakkında bilgi (sistem veya kullanıcı)
final_status	string	Başarılı veya başarısız teklif tamamlama durumu
pipeline_reject_reasons	array	Reddetme nedenleri hakkında bilgi içeren dizi. Pipeline_reject_reason_id, title ve position bilgilerini içerir.

Categories (сrm_status)#

"Müşteri Süreçleri" - "Kategoriler" bölümünde müşteri kategorisi ayarları düzenlendiğinde "event_type": "crm_status" ile event gönderimi tetiklenir.

Olay türleri:

created_status - yeni bir kategori oluşturulduğunda gönderilen olay
updated_status - mevcut bir kategori düzenlendiğinde gönderilen olay
deleted_status - mevcut bir kategori silindiğinde gönderilen olay
reordered_status - süreç listesinde kategorinin sırası değiştiğinde gönderilen olay
assigned_status - müşteriye bir kategori atandığında gönderilen olay
changed_require_update_of_status - "Bir görüşmeyi sonlandırırken Kategori alanının güncellenmesi istensin" ayarı değiştirildiğinde gönderilen olay

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_status",
		"event": {
			"event_name": "assigned_status",
			"status": {
				"title": "unsuccessful",
				"color": "76869d",
				"position": 3,
				"status_id": 5,
				"new_status_id": null
			},
			"client": {
				"client_id": 1,
				"widget": {
					"widget_id": 488651
				},
				"name": "John Smith",
				"avatar_url": null,
				"description": null,
				"social": null,
				"assigned_agent": {
					"assigned_agent_id": null
				},
				"crm_link": null,
				"chats_count": 0,
				"visits_count": 0,
				"custom_data": null,
				"status": {
					"title": "unsuccessful",
					"color": "76869d",
					"position": 3,
					"status_id": 5,
					"new_status_id": null
				},
				"organization": null,
				"tags": [],
				"has_deal": 1,
				"contacts": [{
					"contact_type": "email",
					"contact": "johnsmith@mail.com",
					"channel_type": "agent_app"
				}],
				"blacklist": null
			}
		}
	}

Client nesnesi parametrelerinin açıklaması Webhook API belgelerinde mevcuttur: https://www.jivochat.com.tr/docs/webhooks/#event-parameters

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_status",
		"event": {
			"event_name": "created_status"/"updated_status"/"deleted_status";
			"title": "Vno",
			"color": "0363f6",
			"position": 6,
			"status_id": 6,
			"new_status_id": null
		}
}

Olay Parametreleri

Parametre adı	Tür	Açıklama
event_name	string	Olay türü
title	string	Kategori adı
color	string	Öğe rengi (HEX biçiminde belirtilir)
position	number	Sıra numarası (kategorinin listedeki konumu
status_id	number	Kategori ID'si
new_status_id	number	Yeni kategori ID'si

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_status",
		"event": {
			"event_name": "assigned_status",
			"status": {
				"title": "unsuccessful",
				"color": "76869d",
				"position": 3,
				"status_id": 5,
				"new_status_id": null
			},
			"client": {
				"client_id": 1,
				"widget": {
					"widget_id": 488651
				},
				"name": "John Smith",
				"avatar_url": null,
				"description": null,
				"social": null,
				"assigned_agent": {
					"assigned_agent_id": null
				},
				"crm_link": null,
				"chats_count": 0,
				"visits_count": 0,
				"custom_data": null,
				"status": {
					"title": "unsuccessful",
					"color": "76869d",
					"position": 3,
					"status_id": 5,
					"new_status_id": null
				},
				"organization": null,
				"tags": [],
				"has_deal": 1,
				"contacts": [{
					"contact_type": "email",
					"contact": "johnsmith@mail.com",
					"channel_type": "agent_app"
				}],
				"blacklist": null
			}
		}
	}

Client nesnesine ilişkin parametrelerin açıklaması aşağıda mevcuttur

Tags (crm_client_tag)#

Bu etkinliğin gönderilmesi, müşterinin profilindeki bir segmenti işaretlemek için kullanılan etiketler yönetilirken tetiklenir. "Müşteri Süreçleri" -> "Etiketler" bölümünde etiket eklemek, silmek veya birleştirmek mümkündür.

Olay türleri:

created_client_tag - yeni bir etiket oluşturulduğunda gönderilen olay
updated_client_tag - mevcut bir etiket düzenlendiğinde gönderilen olay
deleted_client_tag - mevcut bir etiket silindiğinde gönderilen olay
merged_client_tag - mevcut etiketler birleştirildiğinde gönderilen olay
changed_administrator_only_client_tag - "Yeni etiketler sadece yöneticiler tarafından eklenebilir" ayarı düzenlendiğinde gönderilen olay

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_client_tag"/"updated_client_tag"/"deleted_client_tag",
		"event": {
			"event_name": "created_client_tag",
			"tag_id": 1,
			"title": "Test_tag"
		}
}


{
		"site_id": 360882,
		"event_type":"crm_client_tag",
		"event": {
			"event_name": "merged_tag",
			"tag": {
				"tag_id": 6,
				"title": "NewOne"
			},
			"merged_tags": [{
				"tag_id": 9,
				"title": "SecondOne"
			}, {
				"tag_id": 10,
				"title": "ThirdOne"
			}]
		}
}


 {
		"site_id": 360882,
		"event_type":"crm_client_tag",
		"event": {
			"event_name": "changed_administrator_only_client_tag",
			"enabled": 1
		}
}

Olay Parametreleri

Parametre adı	Tür	Açıklama
event_name	string	Olay türü
tag_id	number	Etiket ID'si
title	string	Etiket adı
merged_tags	array	Birleştirilmiş etiketlerle ilgili verileri içeren dizi
enabled	boolean	Etiket yönetimi ayarlarının değiştirilip değiştirilmediği: 1 - yalnızca yöneticiler etiket oluşturabilir; 0 - tüm çalışanlar etiket oluşturabilir

Deals (crm_deal)#

Bu etkinlik kategorisine sahip bir istek, her yeni teklif oluşturulduğunda veya mevcut bir teklifin verileri değiştirildiğinde gönderilir.

Olay Türleri:

created_deal - yeni bir teklif oluşturulduğunda gönderilen olay
updated_deal - mevcut bir teklif düzenlendiğinde gönderilen olay
deleted_deal - mevcut bir teklif silindiğinde gönderilen olay

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_deal",
		"event": {
			"event_name": "created_deal"/"updated_deal"/"deleted_deal",
			"deal_id": 3,
			"client": {
				"client_id": 1
			},
			"title": "Сделка",
			"text": "Описание сделки",
			"amount": null,
			"pipeline": {
				"pipeline_id": 1,
				"pipeline_status": {
					"pipeline_status_id": 1
				},
				"pipeline_reject_reason": {
					"pipeline_reject_reason_id": null
				}
			},
			"assigned_agent": {
				"assigned_agent_id": 1
			},
			"created_ts": 1677837220,
			"closed_ts": null,
			"creator_agent": {
				"creator_agent_id": 1
			}
		}
	}

Olay Parametreleri

Parametre adı	Tür	Açıklama
event_name	string	Olay türü
deal_id	number	Teklif ID'si
client	object	Teklifin eklendiği müşteri ayrıntılarını içeren nesne
title	string	Teklifin başlığı
text	string	Teklif açıklaması
amount	number	Teklif miktarı
pipeline	object	Müşteri sürecini ve teklif kategorisini gösteren obje
assigned_agent	object	Teklife atanan temsilciye ilişkin veriler
created_ts	int	Timestamp
created_ts	int	Teklif oluşturulma zamanı-ts türünden
closed_ts	int	Teklif kapanma zamanı-ts türünden
creator_agent	object	Teklifi oluşturan temsilci hakında bilgi içeren obje

CRM Tasks (crm_task)#

Bu olay, görevler özelliğiyle çalışırken tetiklenir: ekleme, silme, düzenleme vb. İstek gövdesi, görevin kendisiyle ilgili bilgilerin yanı sıra ilişkili müşteri ve anlaşma hakkındaki ayrıntıları da içerir.

Olay Türleri:

created_task - yeni bir görev oluşturulduğunda gönderilen olay
deleted_task - mevcut bir görev silindiğinde gönderilen olay
updated_task - mevcut bir görev düzenlendiğinde gönderilen olay
completed_task - mevcut bir görev tamamlandığında gönderilen olay
fired_task - görev zamanı geldiğinde gönderilen olay

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_task",
		"event": {
			"event_name": "created_task"/"deleted_task"/"updated_task"/"completed task"/"fired_task",
			"text": "Текст задачи",
			"status": "active",
			"task_id": 2,
			"agent": {
				"agent_id": 1
			},
			"client": {
				"client_id": 1
			},
			"notify_ts": 1677838380,
			"created_ts": 1677837822,
			"updated_ts": 1677837842,
			"show_notification": 1,
			"creator_agent": {
				"creator_agent_id": 1
			},
			"deal": {
				"deal_id": 3
			}
		}
	}

Olay Parametreleri

Parametre adı	Tür	Açıklama
event_name	string	Olay türü
text	string	Görev açıklaması
task_id	number	Görev ID'si
agent	object	Görevin atandığı temsilciye dair bilgiyi içeren obje
client	object	Görevin bağlı olduğu müşteri hakkında bilgi
notify_ts	int	Görev hatırlatıcısının tetikleneceği zaman-ts formatında
created_ts	int	Görevin oluşturulma zamanı-ts formatında
updated_ts	int	Görevin güncellenme zamanı-ts formatında
show_notification	boolean	Görev hatırlatıcısının gösterilip gösterilmeyeceği. 1 - hatırlatma etkin, 0 - gösterilmeyecek
creator_agent	object	Görevi oluşturan temsilciye dair bilgi
deal	object	Görevle ilişkilendirilmiş teklife dair bilgi içeren obje

Organizations (crm_organization)#

Bu olay, bir müşteriyle ilişkilendirilebilecek bir kuruluş(şirket) oluşturulurken gönderilir. Bu kategoride yalnızca tek bir etkinlik türü mevcuttur - created_organization, çünkü organizasyonlarla ilgili diğer işlemler mevcut değildir. İstek gövdesi yalnızca 2 parametre içerir: event_name and organization_id.

Örnek:


{
 "site_id": 464056,
 "event_type": "crm_organization",
 "event": {
    "event_name": 
		"created_organization",
		"organization_id": 3,
  }
}

Clients (сrm_client)#

Olaylar, müşteri profilini içeren eylemlerle tetiklenir: eklenmesi, düzenlenmesi veya silinmesi.

Olay Türleri:

assigned_agent_to_client - müşteriye bir temsilci atandığında gönderilen olay
created_client - bir müşteri oluşturulduğunda gönderilen olay
deleted_client - mevcut bir müşteri silindiğinde gönderilen olay
updated_client - mevcut bir müşteri profili güncellendiğinde gönderilen olay
changed_client_company - müşterinin ilişkili olduğu firma değiştirildiğinde gönderilen olay
changed_client_blacklist - müşteri karalisteye eklendiğinde veya listeden çıkartıldığında gönderilen olay
updated_client_contacts - müşteri iletişim bilgisi değiştirildiğinde gönderilen olay

Webhook'un gövde yapısı ve parametreleri, bu etkinlik türlerinin her biri için aynıdır.

Örnek:


{
		"site_id": 464056,
		"event_type": "crm_client",
		"event": {
			"event_name": "assigned_agent_to_client",
			"client_id": 1,
			"widget": {
				"widget_id": 488651
			},
			"name": "John Smith",
			"avatar_url": null,
			"description": null,
			"social": null,
			"assigned_agent": {
				"assigned_agent_id": 2
			},
			"crm_link": null,
			"chats_count": 0,
			"visits_count": 0,
			"custom_data": null,
			"status": {
				"title": "new",
				"color": "1fb6fd",
				"position": 0,
				"status_id": 1,
				"new_status_id": null
			},
			"organization": {
				"organization_id": 3,
				"name": "Company"
			},
			"tags": [],
			"has_deal": 1,
			"contacts": [{
				"contact_type": "email",
				"contact": "johnsmith@mail.com",
				"channel_type": "agent_app"
			}],
			"blacklist": {
				"agent": {
					"agent_id": 1
				},
				"block_datetime_ts": 1677838504,
				"unblock_datetime_ts": 1709460904,
				"ip_address": "109.252.14.36"
		}
	}

Olay Parametreleri

Parametre adı	Tür	Açıklama
event_name	string	Olay türü
client_id	number	Müşteri ID'si
widget	object	Müşterinin eklendiği iletişim kanalına ilişkin bilgiler (public channel ID bilgisini içerir)
name	string	Müşterinin adı
client	object	Görevin bağlı olduğu müşteriye dair bilgi
avatar_url	string	Müşterinin avatarını içeren medya dosyasına bağlantı (böyle bir bağlantının sağlanabileceği sosyal medya kanalları ve sohbet API'leri için geçerlidir)
description	string	Müşteri profilindeki detaylar
social	object	Müşterinin sosyal ağlardaki ve mesajlaşma programlarındaki profillerine bağlantılar içeren nesne
crm_link	string	Müşterinin CRM bölümündeki profiline ait bağlantı
chats_count	number	Müşteriyle yapılan sohbet sayısı
visits_count	number	Ziyaret sayısı
custom_data	object	setCustom Data yöntemi kullanılarak iletilen müşteri hakkında ek bilgiler
status	object	Müşteriye atanmış olan kategori
organization	object	Müşterinin ilişkilendirilmiş olduğu şirket
tags	array	Müşteriye atanmış etiketler
has_deal	boolean	Müşteriyle bir teklif oluşturulup oluşturulmadığını belirtir
contacts	array	Müşterinin iletişim bilgileri
contact_type	string	iletişim türü: phone/email - telefon numarası/e-posta adresi
contact	string	telefon numarası/e-posta adresi
channel_type	string	İletişim bilgilerinin eklendiği yer: agent_app - temsilci uygulaması, widget - harici kişiler
blacklist	object	Müşterinin kara listeye eklenmesi veya engelinin kaldırılmasına ilişkin veriler
agent	object	Ziyaretçiyi engelleyen temsilci hakkında bilgi
block_datetime_ts	int	Engelleme zamanı-ts formatında
unblock_datetime_ts	int	Engel kaldırma zamanı-ts formatında
ip_address	string	Müşterinin IP adresi