เหตุการณ์ที่เว็บฮุ๊ครองรับ

Mbox เผยแพร่เหตุการณ์ต่าง ๆ ไปยังปลายทางเว็บฮุคที่กำหนดค่าไว้ หากคุณต้องการกำหนดค่าเว็บฮุค โปรดดูคำแนะนำ แต่ละเหตุการณ์มีโครงสร้างเพย์โหลดตามประเภทของโมเดลที่กำลังดำเนินการ ส่วนต่อไปนี้จะอธิบายถึงวัตถุหลักที่เราใช้ใน Mbox และคุณลักษณะของวัตถุเหล่านั้น

วัตถุประสงค์

เหตุการณ์สามารถมีวัตถุใด ๆ ต่อไปนี้เป็นเพย์โหลด อ็อบเจกต์ประเภทต่างๆ ที่รองรับใน MBOX มีดังนี้

บัญชี

เพย์โหลดต่อไปนี้จะถูกส่งกลับสำหรับบัญชี

{
  "id": "integer",
  "name": "string"
}

กล่องข้อความ

เพย์โหลดต่อไปนี้จะถูกส่งกลับสำหรับกล่องจดหมายเข้า

{
  "id": "integer",
  "name": "string"
}

ข้อมูลติดต่อ

เพย์โหลดต่อไปนี้จะถูกส่งคืนสำหรับผู้ติดต่อ

{
  "id": "integer",
  "name": "string",
  "avatar": "string",
  "type": "contact",
  "account": {
    // <...Account Object>
  }
}

ผู้ใช้

เพย์โหลดต่อไปนี้จะถูกส่งคืนให้กับพนักงาน/แอดมิน

{
  "id": "integer",
  "name": "string",
  "email": "string",
  "type": "user"
}

การสนทนา​

เพย์โหลดต่อไปนี้จะถูกส่งกลับสำหรับการสนทนา

{
  "additional_attributes": {
    "browser": {
      "device_name": "string",
      "browser_name": "string",
      "platform_name": "string",
      "browser_version": "string",
      "platform_version": "string"
    },
    "referer": "string",
    "initiated_at": {
      "timestamp": "iso-datetime"
    }
  },
  "can_reply": "boolean",
  "channel": "string",
  "id": "integer",
  "inbox_id": "integer",
  "contact_inbox": {
    "id": "integer",
    "contact_id": "integer",
    "inbox_id": "integer",
    "source_id": "string",
    "created_at": "datetime",
    "updated_at": "datetime",
    "hmac_verified": "boolean"
  },
  "messages": ["Array of message objects"],
  "meta": {
    "sender": {
      // Contact Object
    },
    "assignee": {
      // User Object
    }
  },
  "status": "string",
  "unread_count": "integer",
  "agent_last_seen_at": "unix-timestamp",
  "contact_last_seen_at": "unix-timestamp",
  "timestamp": "unix-timestamp",
  "account_id": "integer"
}

Message​

{
  "id": "integer",
  "content": "string",
  "message_type": "integer",
  "created_at": "unix-timestamp",
  "private": "boolean",
  "source_id": "string / null",
  "content_type": "string",
  "content_attributes": "object",
  "sender": {
    "type": "string - contact/user"
    // User or Contact Object
  },
  "account": {
    // Account Object
  },
  "conversation": {
    // Conversation Object
  },
  "inbox": {
    // Inbox Object
  }
}

ตัวอย่าเว็บฮุคเพย์โหลด​

{
  "event": "event_name"
  // Attributes related to the event
}

Webhook Events​

MBOX รองรับกิจกรรมเว็บฮุคต่อไปนี้ คุณสามารถสมัครสมาชิกได้ในขณะที่กำหนดค่าเว็บฮุคในแดชบอร์ดหรือใช้ API

conversation_created​

เหตุการณ์นี้จะเกิดขึ้นเมื่อมีการสร้างการสนทนาใหม่ในบัญชี เพย์โหลดสำหรับเหตุการณ์มีดังนี้

{
  "event": "conversation_created"
  // <...Conversation Attributes>
}

conversation_updated​

เหตุการณ์นี้จะถูกทริกเกอร์เมื่อมีการเปลี่ยนแปลงแอตทริบิวต์ใดๆ ในการสนทนา

{
  "event": "conversation_updated",
  "changed_attributes": [
    {
      "<attribute_name>": {
        "current_value": "",
        "previous_value": ""
      }
    }
  ]
  // <...Conversation Attributes>
}

conversation_status_changed​

เหตุการณ์นี้จะถูกเรียกเมื่อสถานะของการสนทนามีการเปลี่ยนแปลง

หมายเหตุ: หากคุณใช้ Agent bot API แทน webhooks เหตุการณ์นี้ยังไม่รองรับ

{
  "event": "conversation_status_changed"
  // <...Conversation Attributes>
}

message_created​

เหตุการณ์นี้จะเกิดขึ้นเมื่อมีการสร้างข้อความในการสนทนา เพย์โหลดสำหรับเหตุการณ์มีดังนี้

{
  "event": "message_created"
  // <...Message Attributes>
}

message_updated​

เหตุการณ์นี้จะเกิดขึ้นเมื่อมีการอัปเดตข้อความในการสนทนา เพย์โหลดสำหรับเหตุการณ์มีดังนี้

{
  "event": "message_updated"
  // <...Message Attributes>
}

webwidget_triggered​

เหตุการณ์นี้จะถูกเรียกใช้เมื่อผู้ใช้ปลายทางเปิดวิดเจ็ตแชทสด

{
  "id": ,
  "contact": {
    // <...Contact Object>
  },
  "inbox": {
    // <...Inbox Object>
  },
  "account": {
    // <...Account Object>
  },
  "current_conversation": {
    // <...Conversation Object>
  },
  "source_id": "string",
  "event": "webwidget_triggered",
  "event_info": {
    "initiated_at": {
      "timestamp": "date-string"
    },
    "referer": "string",
    "widget_language": "string",
    "browser_language": "string",
    "browser": {
      "browser_name": "string",
      "browser_version": "string",
      "device_name": "string",
      "platform_name": "string",
      "platform_version": "string"
    }
  }
}