Webhook

Ngày cập nhật: 06 tháng 11, 2024
Người cập nhật: VNPT eContract's team

---

Mục đích

Phía đối tác xây dựng một RESTful API với các tham số như bên dưới để tiếp nhận và xử lý dữ liệu từ webhook:

• URL endpoint (do đối tác cung cấp), ví dụ: https://domain-partner.com/api/document/status
• HTTP method: POST
• HTTP content-type: application/json
• Authorization: Bearer token (tuỳ chọn nếu cần bảo mật)
• Payload: Dữ liệu sẽ được hệ thống VNPT eContract gửi dưới dạng JSON với cấu trúc như sau

Mẫu Payload (hệ thống đối tác sẽ nhận được)

{
    "DocumentNo": "HD.001",
    "DocumentId": "fa07d61e-0fff-41a3-e618-08dad69d1b1b",
    "DocumentStatus": {
        "Value": -1,
        "Description": "Đã bị từ chối"
    },
    "Reason": "Mã chứng từ không đúng quy định",
    "DatetimeNow": "2024/11/06 14:56:50"
}

Mô tả dữ liệu

Key	Type	Description
DocumentId	string	Id chứng từ
DocumentNo	string	Mã chứng từ
DocumentStatus	object	Trạng thái chứng từ, tham khảo định nghĩa trạng thái tại Lấy danh sách chứng từ
Reason	string	Lý do hủy chứng từ
BatchProcessId	string	Id lô xử lý chứng từ (trường hợp sự kiện xử lý hàng loạt các quy trình)
BatchImportId	int	Id lô import chứng từ (trường hợp sự kiện hoàn tất tạo lô chứng từ)
DocumentIdInBatchImport	Array[int]	Danh sách Id chứng từ trong lô (trường hợp sự kiện hoàn tất tạo lô chứng từ)
DatetimeNow	Datetime	Thời gian thực hiện

Mẫu response (reponse cho hệ thống VNPT eContract)

{
  "success": true,
  "messages": "Document status updated successfully."
}