Hướng dẫn Webhook – Data out

Webhook (hay còn gọi là web callback và HTTP push API) là một tính năng rất hữu ích trong việc triển khai các event reaction trên website. Webhook cung cấp cơ chế giúp server-side thông báo cho client-side khi có một sự kiện mới xảy ra trên máy chủ.

Giới thiệu chung

Giới thiệu về Webhook

Mobio sẽ gửi các request http (method POST) đến webhook url của ứng dụng khi có tương tác từ người dùng hoặc các thay đổi liên quan đến dữ liệu người dùng. Các sự kiện webhook được gửi dưới dạng các yêu cầu POST đến webhook đã đăng ký trong trang cài đặt ứng dụng của bạn.

Thiết lập Webhook

Nhà phát triển tạo ứng dụng và cung cấp URL webhook do nhà phát triển tạo thông qua cài đặt trên Mobio. 

Mobio sẽ cố gắng xác minh webhook của bạn còn online hay không bằng cách gửi yêu cầu GET đến URL webhook.

Nếu webhook không phản hồi thì Mobio sẽ thông báo bằng email theo thông tin trên ứng dụng, nếu webhook không phản hồi liên tục trong 1 giờ thì ứng dụng của nhà phát triển sẽ bị ngừng nhận tin từ Mobio cho tới khi webhook phản hồi trở lại.

Yêu cầu hiệu suất cho webhook:

  • Phản hồi tất cả sự kiện webhook với http status code = 200 OK.
  • Phản hồi tất cả sự kiện webhook tối đa 100ms.

Nếu webhook của bạn không đáp ứng được bất kỳ yêu cầu nào ở trên thì sẽ nhận được thông báo webhook không hoạt động gửi về email theo thông tin trên ứng dụng.

Mobio hỗ trợ gửi lại sự kiện về địa chỉ webhook đã đăng ký đối với những sự kiện gửi không thành công (Không mở được connection tới webhook url)

  • Mobio sẽ liên tục gửi lại trong khoảng thời gian là 1 giờ cho tới khi bạn nhận được. Tần suất gửi lại sự kiện theo cách tính số fibonacci với lần đầu tiên là 5 phút sau khi có thông báo đầu tiên về sự cố webhook.
  • Bạn cần xử lý để webhook hoạt động lại trong khoảng thời gian sự kiện được gửi lại. Nếu webhook của bạn tiếp tục không đáp ứng được yêu cầu trong khoảng thời gian đó, bạn sẽ nhận được thông báo webhook đã bị vô hiệu hóa nhận các sự kiện webhook.
  • Sau khi khắc phục sự cố với webhook. Bạn cần xin lại quyền nhận sự kiện trong trang cài đặt của ứng dụng.

Xác thực sự kiện webhook

Webhook đã gửi sẽ chứa Tiêu đề HTTP X-mevent-signature trên header cùng với chữ ký SHA256 của phần tải dữ liệu. Máy chủ có thể sử dụng thông tin này để bỏ qua những webhook không chứa chữ ký mong muốn, cũng như bỏ qua những cuộc tấn công theo cách chèn webhook.

Chữ ký được tính bằng phương pháp băm dữ liệu webhook cùng với id ứng dụng và secret key của ứng dụng. Điểm cuối gọi lại của bạn có thể xác minh chữ ký này để xác thực tính toàn vẹn và nguồn gốc Ứng dụng của phần tải dữ liệu.

Cấu trúc dữ liệu chung

Ví dụ

{
"merchant_id": "02e2261e-c879-4229-9bf2-bc269be3f1f3",
"block_event": [{...}],
"request_id": "4a9f6012-5627-4239-b281-4adb85c00827",
"version": 1,
 	"timestamp": 15503500848
"app_id": "8563bdcc-d36c-460f-850b-35927d689d56",   
}

Mô tả thuộc tính

Thuộc tínhMô tả
merchant_idId Merchant trên hệ thống Mobio
request_idid lần gọi url webhook 
versionphiên bản mẫu dữ liệu
app_idid ứng dụng 
timestampThời điểm request được gửi, tính bằng giây.
block_eventdanh sách dữ liệu trong lần request đó, tối đa 50 phần tử.
VD: 
[   
{       “message_id”: “03f5b371-6d3a-40c6-9375-fefe5863ab92”, 
“data_event”: {…},       
“event_type”: “”   
}
]
message_id: id event.
event_type: key xác định loại event.
data_event: dữ liệu event, mô tả chi tiết trong tài liệu từng event type.

Các loại dữ liệu được truy xuất

Tạo mới profile

Khi 1 profile được tạo mới trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
"message_id": "643d6cf6-0cf5-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658848359.390879,
        "merchant_id": [
          "1b99bdcf-d582-4f49-9715-1b61dfff3924"
        ],
        "event_type": "profile_create_new",
        "profile_id": "bcaf9924-131f-4b24-86d9-1ca0604a2056",
        "fields": [
          {
            "display_type": "date_picker",
            "remove": [],
            "add": [
              "2022-07-26T15:12:39.390879Z"
            ],
            "field_key": "created_time",
            "change": [],
            "field_property": 3,
            "field_name": "created_time",
            "format": "dd/mm/yyyy hh:mm"
          },
          {
            "display_type": "multi_line",
            "remove": [],
            "add": [
              "anv@gmail.com"
            ],
            "field_key": "email",
            "change": [],
            "field_property": 6,
            "field_name": "secondary_emails",
            "format": null
          },
          {
            "display_type": "single_line",
            "remove": [],
            "add": [
              "anv@gmail.com"
            ],
            "field_key": "primary_email",
            "change": [],
            "field_property": 6,
            "field_name": "primary_email",
            "format": null
          },
          {
            "display_type": "multi_line",
            "remove": [],
            "add": [
              "+84985645631"
            ],
            "field_key": "phone_number",
            "change": [],
            "field_property": 7,
            "field_name": "secondary_phones",
            "format": null
          },
          {
            "display_type": "single_line",
            "remove": [],
            "add": [
              "Nguyễn Văn A"
            ],
            "field_key": "name",
            "change": [],
            "field_property": 2,
            "field_name": "name",
            "format": null
          },
          {
            "display_type": "tags",
            "remove": [],
            "add": [
              "541005c4-3dff-4063-8e77-66cc140015b8"
            ],
            "field_key": "profile_group",
            "change": [],
            "field_property": 2,
            "field_name": "profile_group",
            "format": null
          },
          {
            "display_type": "single_line",
            "remove": [],
            "add": [
              "+84985645631"
            ],
            "field_key": "primary_phone",
            "change": [],
            "field_property": 7,
            "field_name": "primary_phone",
            "format": null
          },
          {
            "display_type": "dropdown_single_line",
            "remove": [],
            "add": [
              -1
            ],
            "field_key": "province_code",
            "change": [],
            "field_property": 14,
            "field_name": "province_code",
            "format": null
          }
        ],
        "_id": "E80::bcaf9924-131f-4b24-86d9-1ca0604a2056::1658848359.390879"
      },
      "event_type": "profile_create_new"
    }

Mô tả dữ liệu trong từng block_event

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
data_eventStringTRUEThông tin chi tiết của event
merchant_idStringTRUEMerchant ID
profile_idStringTRUEProfile ID
action_timeFloat (timestamp)TRUEThời gian diễn ra event
event_typeStringGiá trị luôn là: “profile_create_new”
fieldsArrayDanh sách các field có giá trị
field_nameStringTên trường dữ liệu
field_keyStringKey của trường dữ liệu (field_key là duy nhất trong 1 merchant)
display_typeStringEnum: single_line / multi_line / dropdown_single_line / dropdown_multi_line / radio / checkbox / date_picker / tags
field_propertyInt1 : INTEGER
4 : FLOAT
2 : STRING
3 : DATETIME
5 : DICT
6 : EMAIL
7 : PHONE_NUMBER
8 : GENDER
9 : RELATIONSHIP_DATA
10 : RELATION_WITH_CHILDS
11 : CHILDS
12 : SOCIAL_TAGS
13 : SOCIAL_USER
14 : UDT15 : CARDS
16 : PUSH_ID
formatStringFormat của field khi display_type là “date_picker”. Enum: “dd/mm” – “dd/mm/yyyy” – “dd/mm/yyyy hh:mm”
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
changeArray[Object]Giá trị thay đổi
from_valueGiá trị ban đầu
to_valueGiá trị mới
event_typeStringTRUEGiá trị luôn là “profile_create_new”

Cập nhật thông tin profile

Khi 1 profile cập nhật thông tin, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
"message_id": "b0914c58-0cf5-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658848487.946152,
        "merchant_id": [
          "1b99bdcf-d582-4f49-9715-1b61dfff3924"
        ],
        "event_type": "profile_update",
        "profile_id": "bcaf9924-131f-4b24-86d9-1ca0604a2056",
        "fields": [
          {
            "display_type": "single_line",
            "remove": [],
            "add": [],
            "field_key": "name",
            "change": [
              {
                "to_value": "Nguyễn Văn An",
                "from_value": "Nguyễn Văn A"
              }
            ],
            "field_property": 2,
            "field_name": "name",
            "format": null
          }
        ],
        "_id": "E80::bcaf9924-131f-4b24-86d9-1ca0604a2056::1658848487.946152"
      },
      "event_type": "profile_update"
    }

 Mô tả dữ liệu

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
data_event
merchant_idStringTRUEMerchant ID
profile_idStringTRUEProfile ID
action_timeFloat (timestamp)TRUEThời gian diễn ra event
event_typeStringGiá trị luôn là: “profile_update”
fieldsArrayDanh sách các field có giá trị
field_nameStringTên trường dữ liệu
field_keyStringKey của trường dữ liệu (field_key là duy nhất trong 1 merchant)
display_typeStringEnum: single_line / multi_line / dropdown_single_line / dropdown_multi_line / radio / checkbox / date_picker / tags
field_propertyInt1 : INTEGER
4 : FLOAT
2 : STRING
3 : DATETIME
5 : DICT
6 : EMAIL
7 : PHONE_NUMBER
8 : GENDER
9 : RELATIONSHIP_DATA
10 : RELATION_WITH_CHILDS
11 : CHILDS
12 : SOCIAL_TAGS
13 : SOCIAL_USER
14 : UDT
15 : CARDS
16 : PUSH_ID
formatStringFormat của field khi display_type là “date_picker”. Enum: “dd/mm” – “dd/mm/yyyy” – “dd/mm/yyyy hh:mm”
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
changeArray[Object]Giá trị thay đổi
from_valueGiá trị ban đầu
to_valueGiá trị mới
event_typeStringTRUEGiá trị luôn là “profile_update”

Gửi email cho profile

Khi có 1 user gửi mail cho profile từ hệ thống MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "21050ab4-0cf7-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658849106,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "event_type": "profile_sent_email",
        "profile_id": "425a95d4-60d8-4b05-8cc9-c8aa57a65069",
        "body": {
          "from_email": "haptt@mobio.io",
          "profile_data": {
            "name": "15cf6a5c-28de-47de-8a04-264048ad110b",
            "id": "425a95d4-60d8-4b05-8cc9-c8aa57a65069"
          },
          "content": "<div style=\"text-align: justify;\"><strong><em>Kính gửi Quý Khách hàng,</em></strong>&nbsp;</div><div style=\"text-align: justify;\">Mong muốn đem đến cho khách hàng những trải nghiệm tốt hơn mỗi ngày,&nbsp;<strong style=\"color: rgb(192, 0, 0);\">Công ty Cổ phần Chứng khoán </strong>luôn cố gắng nâng cấp giao diện để hoàn thiện ứng dụng. Vì vậy, chúng tôi cho ra mắt phiên bản mới của giao diện phái sinh để giúp khách hàng nâng tầm trải nghiệm.</div><div style=\"text-align: justify;\">Với giao diện mới tốt hơn, đẹp hơn, Siêu ứng dụng sẽ đem đến cho bạn:</div><div>·&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Giao diện hiện đại, tối ưu trải nghiệm</div><div>·&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tốc độ đặt lệnh nhanh chóng ưu việt</div><div>·&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dễ dàng theo dõi hiệu quả đầu tư</div><div><br></div> <img src=\"https://t1.mobio.vn//mailclient/webhook/nepo.gif?id=1dff6ba2-0cf7-11ed-95fb-3e012749f6e2\" height=\"1\" width=\"1\" alt=\"\"/>",
          "subject": "Kính gửi Quý khách hàng.",
          "status": {
            "type": "success",
            "message": ""
          },
          "to_email": [
            "nguyenvana@gmail.com"
          ],
          "bcc_email": [],
          "cc_email": []
        },
        "_id": "9959c9682ccd82395239b2d3290a576f",
        "email_id": "205cfbf8-0cf7-11ed-8d4f-06156a96cf6c"
      },
      "event_type": "profile_sent_email"
    }

Mô tả dữ liệu

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEID của merchant trên hệ thống Mobio
profile_idStringTRUEID của profile trên hệ thống Mobio
action_timeFloat (timestamp)TRUEThời gian diễn ra event
event_typeStringGiá trị luôn là: “profile_sent_email”
email_idStringID của email trên hệ thống Mobio
bodyObjectThông tin chi tiết email
profile_dataObjectThông tin profile nhận email
idStringID của profile trên hệ thống Mobio
nameStringTên của profile trên hệ thống Mobio
from_emailStringEmail gửi
to_emailArray[String]Danh sách email nhận
cc_emailArray[String]Danh sách email cc
bcc_emailArray[String]Danh sách email bcc
subjectStringSubject của email
contentStringNội dung html của email
statusObjectTrạng thái của email
typeStringEnum: success / pending / failed
messageStringMô tả chi tiết

Profile mở email

Khi 1 profile mở email được gửi từ 1 user trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

  {
      "message_id": "f66ffec2-0d9a-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658919472,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "event_type": "profile_open_email",
        "profile_id": "271b8657-cbf5-4d4b-84b9-1305671fe867",
        "body": {
          "from_email": "haptt@mobio.io",
          "profile_data": {
            "name": "Dương Ngân",
            "id": "271b8657-cbf5-4d4b-84b9-1305671fe867"
          },
          "email_id": "e9a9fe18-0d9a-11ed-b9c8-3e012749f6e2",
          "subject": "Test."
        },
        "_id": "fc631e3488f6e5fd3b35d375fef41658"
      },
      "event_type": "profile_open_email"
    }

Mô tả dữ liệu

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEID của merchant trên hệ thống Mobio
profile_idStringTRUEID của profile trên hệ thống Mobio
action_timeFloat (timestamp)TRUEThời gian diễn ra event
event_typeStringTRUEGiá trị luôn là: “profile_open_email”
bodyObjectTRUEThông tin chi tiết email
profile_dataObjectTRUEThông tin profile nhận email
idStringTRUEID của profile trên hệ thống Mobio
nameStringTên của profile trên hệ thống Mobio
from_emailStringTRUEEmail gửi
subjectStringSubject của email
email_idStringTRUEID của email gửi

Profile trả lời email

Khi 1 profile trả lời email được gửi từ 1 user trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "d2dc8662-0d34-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658875468,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "event_type": "profile_reply_email",
        "profile_id": "425a95d4-60d8-4b05-8cc9-c8aa57a65069",
        "body": {
          "from_email": "nguyenvana@gmail.com",
          "profile_data": {
            "name": "15cf6a5c-28de-47de-8a04-264048ad110b",
            "id": "425a95d4-60d8-4b05-8cc9-c8aa57a65069"
          },
          "subject": "Re: Kính gửi Quý khách hàng.",
          "status": {
            "type": "success",
            "message": ""
          },
          "to_email": [
            "haptt@mobio.io"
          ],
          "bcc_email": [],
          "cc_email": []
        },
        "_id": "b96f8a88a7161f3ad089216417ab8827",
        "email_id": "CALwN20q1wt=gvVVJaGbB7h_6ecFXK-0_kuF9t-PvO_9e_e9Qrw@mail.gmail.com"
      },
      "event_type": "profile_reply_email"
    }

Mô tả dữ liệu

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEID của merchant trên hệ thống Mobio
profile_idStringTRUEID của profile trên hệ thống Mobio
action_timeFloat (timestamp)TRUEThời gian diễn ra event
event_typeStringTRUEGiá trị luôn là: “profile_reply_email”
email_idStringTRUEID của email trên hệ thống Mobio
bodyObjectTRUEThông tin chi tiết email
profile_dataObjectTRUEThông tin profile nhận email
idStringTRUEID của profile trên hệ thống Mobio
nameStringTên của profile trên hệ thống Mobio
from_emailStringTRUEEmail gửi
to_emailArray[String]TRUEDanh sách email nhận
cc_emailArray[String]Danh sách email cc
bcc_emailArray[String]Danh sách email bcc
subjectStringTRUESubject của email
statusObjectTrạng thái của email
typeStringEnum: success / pending / failed
messageStringMô tả chi tiết

Dynamic event

Khi 1 phát sinh event dynamic được tạo trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

  {
      "message_id": "104da332-0cfe-11ed-9d73-aea73dddcfef",
      "data_event": {
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "profile_id": "61fc82ba-2a99-4479-9ade-aca237de35dc",
        "created_time": 1658852084.960893,
        "_id": "62e012f4e195422d65a43a2d",
        "tracking_code": "kKhKo9wjNCOhZzc8DO7KB",
        "event_data": {
          "build": "1",
          "version": "1.0",
          "action_time": 1658852083
        },
        "event_key": "sdk_mobile_test_open_app",
        "event_id": "617b62281091b503226ae052"
      },
      "event_type": "profile_dynamic_event"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tảGhi chú
message_idStringTRUEID event trên hệ thống Mobio 
merchant_idStringTRUEMerchant ID 
profile_idStringTRUEProfile ID 
event_idStringTRUEID cấu trúc data event 
event_keyStringTRUEKey cấu trúc data event 
event_dataDictTRUEDữ liệu của event
Example:
{
“action_time”: 1651717036.123, “key”: “value”,

}
Trong event_data: action_time là trường bắt buộc. action_time: giờ UTC
tracking_codeStringTRUEMã tracking 
created_timeTimestampTRUEThời gian tạo event trên hệ thống Mobio
Example: 1651717036.123
Giờ UTC

Lượt profile thoát khỏi journey

Khi 1 profile thoát khỏi journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "249eb88a-0cef-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658845676.391012,
        "journey_id": "1a596c15-3ccb-4d51-8d75-03223c5bce8e",
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "event_type": "FINISHED_JOURNEY",
        "profile_id": "ee800025-2740-43f2-8f47-f56cd4f1eafb",
        "master_campaign_id": "a065a9fd-2341-468b-8580-dba1cc4b3459",
        "event_id": "11b32858-c4ef-41df-87f8-1ec34dbe0b53"
      },
      "event_type": "profile_out_jb"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeStringTRUEThời gian diễn ra event

Lượt profile vào khối

Khi 1 profile vào 1 khối bất kỳ trên journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "19db4e86-0cef-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658845656.471722,
        "journey_id": "1a596c15-3ccb-4d51-8d75-03223c5bce8e",
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "64690a9e-e807-4b2a-8da2-f2d28d085fd2",
        "node_code": "WEB_PUSH",
        "event_type": "IN_NODE",
        "profile_id": "ff5d808c-5a28-415f-b60d-9070519e7f1a",
        "master_campaign_id": "a065a9fd-2341-468b-8580-dba1cc4b3459",
        "event_id": "061dbe38-b5db-4470-a1e5-8e2ce2e14851"
      },
      "event_type": "profile_in_node"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile không nhận được thông điệp

Khi 1 profile không nhận được thông điệp gửi từ journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng.

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "bd4a8074-0cf3-11ed-9652-62af3f9de64b",
      "data_event": {
        "event_id": "43d5a70a-0f49-46e5-880d-6d9cc493cbee",
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "journey_id": "f2d9199e-47cb-42eb-978c-84ce4f10460e",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "profile_id": "d1400f84-59a8-43ce-ae6b-da884eeeca4a",
        "action_time": 1658847648.8446,
        "event_type": "PUSH",
        "reason": "Profile không có địa chỉ gửi",
        "node_id": "49fb0c1a-4db3-4991-bcda-795ad52cc366",
        "node_code": "WEB_PUSH"
      },
      "event_type": "profile_not_receive_message"
    },

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey, 
reasonStringTRUELý do profile không nhận được thông điệp

Lượt profile nhận thông điệp

Khi 1 profile nhận được thông điệp từ journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "918ecfd2-0cf1-11ed-9652-62af3f9de64b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "RECEIVED",
        "event_id": "25af2179-2d21-48de-b98f-2fe376c7bc08",
        "action_time": 1658846717.416022,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "d4d008e3-bb01-be05-a911-7916a6e803bb",
        "master_campaign_id": "5e3d73d9-b973-4fed-a2c2-cde652fbcf7e",
        "journey_id": "0f783650-7092-4540-a69d-e736a14ea8ed"
      },
      "event_type": "profile_receive_message"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile mở thông điệp

Khi 1 profile mở thông điệp nhận được từ journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "976f2bfe-0cf1-11ed-9652-62af3f9de64b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "OPENED",
        "event_id": "1fc80415-75ed-4baf-9beb-f5939639d8fe",
        "action_time": 1658846723.743189,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "24bb539a-885e-4181-b31c-84b2169dddea",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "journey_id": "538d951f-7ce6-4fe4-aed3-75d72aed8a45"
      },
      "event_type": "profile_open_message"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Khi 1 profile bấm link trong thông điệp nhận được từ journey, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "1c07d602-0d8f-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658914380.226996,
        "journey_id": "5ae00ac1-2976-4ef2-9b94-4908306271a0",
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "0dbeca17-2b7e-165b-1cb5-9615f7158a8c",
        "node_code": "EMAIL",
        "link": "https://mobio.io",
        "event_type": "LINK_CLICKED",
        "profile_id": "271b8657-cbf5-4d4b-84b9-1305671fe867",
        "master_campaign_id": "a065a9fd-2341-468b-8580-dba1cc4b3459",
        "event_id": "28d10b65-8c2c-4078-8218-6ddb593eac10"
      },
      "event_type": "profile_click_link_message"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
linkStringTRUELink gắn trong thông điệp (có chọn Theo dõi link)
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile thực hiện chuyển đổi CTA

Khi 1 thực hiện chuyển đổi CTA, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "976f2bfe-0cf1-11ed-9652-62af3f94564b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "CTA",
        "event_id": "1fc80415-75ed-4baf-9beb-f593963945fe",
        "action_time": 1658846723.743189,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "24bb539a-885e-4181-b31c-84b2169dddea",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "journey_id": "538d951f-7ce6-4fe4-aed3-75d72aed8a45"
      },
      "event_type": "profile_cta"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile thực hiện chuyển đổi chi tiêu

Khi 1 profile thực hiện chuyển đổi chi tiêu (journey có kiểm tra Chuyển đổi Chi tiêu), MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "976f2bfe-0cf1-11ed-9652-62af3f94564b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "LINK_CLICKED",
        "event_id": "1fc80415-75ed-4baf-9beb-f593963945fe",
        "action_time": 1658846723.743189,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "24bb539a-885e-4181-b31c-84b2169dddea",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "journey_id": "538d951f-7ce6-4fe4-aed3-75d72aed8a45"
      },
      "event_type": "profile_click_link_message"
    }

Mô tả dữ liệu cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile thực hiện mua hàng

Khi 1 profile thực hiện mua hàng (journey có kiểm tra Chuyển đổi Mua hàng), MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "976f2bfe-0cf1-11ed-9652-62af3f94564b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "BOUGHT_PRODUCT",
        "event_id": "1fc80415-75ed-4baf-9beb-f593963945fe",
        "action_time": 1658846723.743189,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "24bb539a-885e-4181-b31c-84b2169dddea",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "journey_id": "538d951f-7ce6-4fe4-aed3-75d72aed8a45"
      },
      "event_type": "profile_transaction_bank"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Lượt profile sử dụng voucher

Khi 1 profile sử dụng voucher, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "976f2bfe-0cf1-11ed-9652-62af3f94564b",
      "data_event": {
        "profile_id": "df059a8b-8669-49ca-9365-1d0573e89192",
        "node_code": "WEB_PUSH",
        "event_type": "USED_VOUCHER",
        "event_id": "1fc80415-75ed-4baf-9beb-f593963945fe",
        "action_time": 1658846723.743189,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "node_id": "24bb539a-885e-4181-b31c-84b2169dddea",
        "master_campaign_id": "a9b4b40e-a0f8-4d4c-9f64-c0787540f2fb",
        "journey_id": "538d951f-7ce6-4fe4-aed3-75d72aed8a45"
      },
      "event_type": "profile_use_voucher"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
merchant_idStringTRUEID của merchant trên hệ thống Mobio
journey_idStringTRUEID của journey trên hệ thống Mobio
master_campaign_idStringTRUEID của Master campaign trên hệ thống Mobio
event_typeStringTRUELoại event 
profile_idStringTRUEID của profile trên hệ thống Mobio
event_idStringTRUEID của event
action_timeFloatTRUEThời gian diễn ra event
node_idStringTRUEID của khối trong Journey
node_codeStringTRUEMã khối trong journey

Tạo đơn hàng

Khi 1 đơn hàng được tạo mới trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "eeafca1a-0d35-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658876078.505126,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "created_time": 1658876078.765139,
        "fields": [
          {
            "remove": [],
            "add": [
              "ZPSYK3Y8"
            ],
            "change": [],
            "field_key": "state_code",
            "field_name": "state_code"
          },
          {
            "remove": [],
            "add": [
              "62cc023369c057ddec9e94fb"
            ],
            "change": [],
            "field_key": "sale_process_id",
            "field_name": "sale_process_id"
          },
          {
            "remove": [],
            "add": [
              5
            ],
            "change": [],
            "field_key": "state_ratio",
            "field_name": "state_ratio"
          }
        ],
        "id": "62e070ae8fa66451707b8444",
        "deal_id": "62e070aefc503549d550c99e"
      },
      "event_type": "sale_create_deal"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
message_idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEMerchant ID
deal_idStringTRUEID đơn hàng
fieldsArrayDanh sách các field có giá trị
field_keyStringTRUEfield key
field_nameStringTRUETên Field
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
changeArrayGiá trị thay đổi
fromGiá trị ban đầu
toGiá trị mới
action_timeFloatTRUEThời gian phát sinh event
created_timeFloatTRUEThời gian tạo event trên hệ thống

Cập nhật thông tin đơn hàng

Khi đơn hàng được cập nhật thông tin trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "ef0aa354-0d35-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658876078.505126,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "created_time": 1658876080.141136,
        "fields": [
          {
            "remove": [],
            "add": [
              {
                "sale_process_id": "62cc023369c057ddec9e94fb",
                "sale_process_name": "Data test",
                "state_name": "Khởi tạo",
                "state_ratio": 5,
                "state_code": "ZPSYK3Y8"
              }
            ],
            "change": [],
            "field_key": "state_code",
            "field_name": "state_code"
          }
        ],
        "id": "62e070b08fa66451707b844b",
        "deal_id": "62e070aefc503549d550c99e"
      },
      "event_type": "sale_update_status"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEMerchant ID
deal_idStringTRUEID đơn hàng
fieldsArrayDanh sách các field có giá trị
field_keyStringTRUEfield key
field_nameStringTRUETên Field
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
changeArrayGiá trị thay đổi
fromGiá trị ban đầu
toGiá trị mới
action_timeFloatTRUEThời gian phát sinh event
created_timeFloatTRUEThời gian tạo event trên hệ thống

Cập nhật thông tin liên hệ giữa profile và đơn hàng

Khi đơn hàng được cập nhật thông tin liên hệ giữa profile và đơn hàng trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "01065c62-0cf8-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658849480.415978,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "created_time": 1658849480.701457,
        "fields": [
          {
            "remove": [],
            "add": [
              {
                "id": "425a95d4-60d8-4b05-8cc9-c8aa57a65069",
                "name": "15cf6a5c-28de-47de-8a04-264048ad110b"
              }
            ],
            "change": [],
            "field_key": "profiles",
            "field_name": "profiles"
          }
        ],
        "id": "62e008c8ab5050d9dc4aa089",
        "deal_id": "62df5b6db603676889967895"
      },
      "event_type": "sale_update_contact"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEMerchant ID
deal_idStringTRUEID đơn hàng
fieldsArrayDanh sách các field có giá trị
field_keyStringTRUEfield key
field_nameStringTRUETên Field
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
action_timeFloatTRUEThời gian phát sinh event
created_timeFloatTRUEThời gian tạo event trên hệ thống

Chuyển trạng thái đơn hàng

Khi 1 đơn hàng được thay đổi trạng thái trên hệ thống, MOBIO sẽ gửi 1 request đến webhook URL đã đăng ký của ứng dụng. 

  • URL: Webhook Url của ứng dụng bên thứ 3
  • Method: POST
  • Content Type: application/json
  • X-mevent-signature: mac = sha256(app_id + data_string + app_secret), với data_string là dữ liệu webhook.

Dữ liệu mẫu từng block event như sau:

{
      "message_id": "ef0aa354-0d35-11ed-9d73-aea73dddcfef",
      "data_event": {
        "action_time": 1658876078.505126,
        "merchant_id": "1b99bdcf-d582-4f49-9715-1b61dfff3924",
        "created_time": 1658876080.141136,
        "fields": [
          {
            "remove": [],
            "add": [
              {
                "sale_process_id": "62cc023369c057ddec9e94fb",
                "sale_process_name": "Data test",
                "state_name": "Khởi tạo",
                "state_ratio": 5,
                "state_code": "ZPSYK3Y8"
              }
            ],
            "change": [],
            "field_key": "state_code",
            "field_name": "state_code"
          }
        ],
        "id": "62e070b08fa66451707b844b",
        "deal_id": "62e070aefc503549d550c99e"
      },
      "event_type": "sale_update_status"
    }

Mô tả dữ liệu trong cụm data_event

Tên fieldKiểu dữ liệuRequiredMô tả
idStringTRUEID event trên hệ thống Mobio
merchant_idStringTRUEMerchant ID
deal_idStringTRUEID đơn hàng
fieldsArrayDanh sách các field có giá trị
field_keyStringTRUEfield key
field_nameStringTRUETên Field
addArrayGiá trị được thêm
removeArrayGiá trị bị xoá
changeArrayGiá trị thay đổi
fromGiá trị ban đầu
toGiá trị mới
action_timeFloatTRUEThời gian phát sinh event
created_timeFloatTRUEThời gian tạo event trên hệ thống

image-zoom
© MOBIO 2022 v1.2 Powered by MOBIO
Back to Top