1. Home
  2. Docs
  3. Hướng dẫn sử dụng FasterC...
  4. API
  5. Webhook

Webhook

Token API v2

Dùng cho /api/v2/…. Token chỉ hiện một lần khi tạo; tạo token mới thì token cũ hết hiệu lực ngay. API cũ (get_data_lead, import) vẫn dùng token cũ.

<domain>/api-settings

Hệ thống cho phép gửi dữ liệu dạng POST JSON tới các URL đích ngay khi phát sinh sự kiện tương ứng trên server (có cơ chế tự động gửi lại nếu xảy ra lỗi).

  • Lưu ý: Nếu để trống URL ở sự kiện nào, hệ thống sẽ không gửi dữ liệu cho sự kiện đó. Hook cũ trong mục Cài đặt chung vẫn hoạt động độc lập.

1. Thông tin cấu hình URL (Endpoints)

Trường cấu hìnhMô tảChức năng hỗ trợ
URL nhận dữ liệu khách hàngNhận payload khi có thay đổi liên quan đến dữ liệu khách hàng.Gửi thử: Cho phép phát dữ liệu mẫu để kiểm tra kết nối.
URL nhận lịch hẹnNhận payload khi tạo hoặc cập nhật lịch hẹn.Gửi thử: Kiểm tra gửi dữ liệu lịch hẹn thử nghiệm.
URL nhận cuộc gọiNhận payload khi cuộc gọi kết thúc hoặc khi hoàn tất file ghi âm.Gửi thử: Kiểm tra kết nối nhận sự kiện cuộc gọi.

2. Xắc thực & Bảo mật (Security & Authentication)

  • Secret Key: Sử dụng Secret Key để ký HMAC-SHA256 bảo mật.
  • Headers: Hệ thống tự động kèm theo hai header trong mọi request gửi đi:
    • X-FasterCRM-Signature: Chứa chữ ký HMAC-SHA256 của payload.
    • X-API-Key: Chứa thông tin Secret Key để xác thực client.
  • Tạo ngẫu nhiên: Nhấp nút Tạo ngẫu nhiên để sinh chuỗi Secret bảo mật mới.

3. Danh sách các sự kiện (Events)

Bạn có thể tích chọn các sự kiện muốn nhận thông báo Webhook:

  • Khách hàng (Customer)
    • customer.created: Phát ra khi tạo mới khách hàng.
    • customer.updated: Phát ra khi cập nhật thông tin khách hàng.
    • customer.note_created: Phát ra khi có ghi chú mới trong hồ sơ khách hàng.
  • Lịch hẹn (Appointment)
    • appointment.created: Phát ra khi tạo mới lịch hẹn.
    • appointment.updated: Phát ra khi cập nhật thông tin lịch hẹn.
  • Cuộc gọi (Call)
    • call.ended: Phát ra ngay khi cuộc gọi kết thúc.
    • call.recording_ready: Phát ra khi tổng đài xử lý xong và cung cấp file ghi âm cuộc gọi.

4. Hướng dẫn sử dụng

  1. Nhập các URL endpoint nhận dữ liệu tương ứng với nhu cầu của hệ thống bên bạn.
  2. Nhấn Tạo ngẫu nhiên hoặc nhập Secret Key tùy chỉnh để xác thực request.
  3. Tích chọn các Sự kiện gửi cần theo dõi.
  4. Bấm Gửi thử tại từng endpoint để đảm bảo server của bạn nhận và xử lý payload thành công.
  5. Chọn Lưu Webhook để áp dụng cấu hình.

Cấu xuất dữ liệu

Tick chọn các trường, tên dữ liệu cần xuất sau đó lưu trường