Tích hợpWebhooks

Sửa webhook

Cập nhật thông tin của một webhook đã đăng ký.

Scope yêu cầu: webhooks:manage.

Path parameters

webhookIdstringRequiredformat: "uuid"

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
namestringOptional
urlstringOptionalformat: "uri"
eventslist of enumsOptional
activebooleanOptional
retryOnFailurebooleanOptional
securityobjectOptional

Phương thức xác thực đính kèm trong request mà hệ thống gửi tới URL webhook của bạn.

alertingobjectOptional

Cấu hình cảnh báo khi webhook liên tục gửi thất bại.

Response

Thành công.

webhookIdstringformat: "uuid"

Mã webhook, dùng cho các endpoint sửa/xoá.

namestring
urlstringformat: "uri"
eventslist of enums
activeboolean
retryOnFailureboolean
securityobject

Giá trị nhạy cảm (apiKey, giá trị header tuỳ chỉnh) chỉ trả về đầy đủ khi type là API_KEY; với CUSTOM_HEADER chỉ trả về tên các header (headerKeys), không trả về giá trị.

alertingobject

Cấu hình cảnh báo khi webhook liên tục gửi thất bại.

createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error