Chuyển tới nội dung
Sursa Developers

Đối tượng

WebhookCreated

Trường

  • idintegerbắt buộc
  • urlstringbắt buộc
  • descriptionstringbắt buộc
  • eventsarray of WebhookEventFilterbắt buộc
  • activebooleanbắt buộc
  • statusWebhookStatusbắt buộc
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 lần thử liên tiếp thất bại; feature_disabled: gói không bao gồm webhook.

  • disabled_reasonstring | null

    gone: máy chủ nhận đã trả lời 410; manual: bị quản trị viên tắt.

    Giá trị cho phép: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRolebắt buộc
  • data_profile_idinteger | null

    Hồ sơ dữ liệu của webhook (null nghĩa là không có hồ sơ, như với khóa API có cùng vai trò).

  • collection_idsarray of integerbắt buộc

    Các bộ sưu tập mà webhook nhận sự kiện về; trống nghĩa là mọi bộ sưu tập mà vai trò và hồ sơ dữ liệu truy cập được.

  • tagsarray of stringbắt buộc

    Sự kiện thẻ chỉ cho các thẻ có ít nhất một trong các nhãn này; trống nghĩa là không lọc.

  • payloadWebhookPayloadModebắt buộc
  • headersarray of WebhookHeaderbắt buộc
  • auth_typestring | null

    Loại thông tin ủy quyền gửi kèm (null nghĩa là không có).

    Giá trị cho phép: bearerbasicnull

  • auth_setbooleanbắt buộc

    Thông tin ủy quyền gửi kèm đã được đặt hay chưa (các giá trị không bao giờ được trả về).

  • previous_secret_valid_untilstring (date-time) | null

    Các lần gửi được ký thêm bằng khóa bí mật cũ cho đến thời điểm nào (null nghĩa là không có thời gian chồng lấn).

  • healthWebhookHealth
  • consecutive_failuresintegerbắt buộc
  • last_delivery_atstring (date-time) | null
  • last_success_atstring (date-time) | null
  • last_errorstring | null
  • created_byinteger | null
  • created_by_namestring | null
  • created_atstring (date-time)bắt buộc
  • updated_atstring (date-time)bắt buộc
  • secretstringbắt buộc

    whsec_ theo sau là 32 byte ở dạng base64 (khóa bí mật mới dùng bảng chữ cái chuẩn có phần đệm, khóa cũ dùng base64url). Hãy lưu nó ở phía máy chủ nhận; nó không bao giờ xuất hiện lại trong phản hồi API. Khóa ký theo Standard Webhooks là kết quả giải mã base64 của phần sau whsec_.

  • previous_valid_untilstring (date-time) | null

    Khóa bí mật cũ còn được chấp nhận đến thời điểm nào (sau khi xoay vòng). null khi tạo.

Được dùng trong