Skip to main content

Sự Kiện Webhook Trao Quyền

Các sự kiện này được kích hoạt mỗi khi quyền của khách hàng thay đổi trạng thái, ví dụ khi một license key được tạo, một vai trò Discord được gán, một liên kết tải xuống được cung cấp hoặc quyền truy cập bị từ chối. Đăng ký các sự kiện này để giữ cho ứng dụng của bạn đồng bộ với những gì mỗi khách hàng có thể truy cập. Cả bốn sự kiện đều chia sẻ cùng một tải trọng EntitlementGrantResponse được tài liệu hóa trong sơ đồ dưới đây.

Kích Hoạt Sự Kiện

entitlement_grant.created

Một dòng cấp quyền vừa được chèn. Quyền luôn có một id ổn định từ lúc này, ngay cả khi trạng thái của nó thay đổi. Sử dụng sự kiện này để ghi lại rằng việc thực hiện đang diễn ra. Đối với license key được tự động fulfillment, row được insert trực tiếp với status: "Delivered"delivered_at đã được điền, vì vậy một event created duy nhất sẽ không có thêm thay đổi trạng thái nào, trừ khi grant bị revoke về sau. Đối với license key được fulfillment thủ công (entitlement có fulfillment_mode: manual), row được tạo với status: "Pending" và không có object license_key — chưa có key. Event này báo hiệu rằng một key đang chờ fulfillment; hãy cung cấp key qua POST /grants/{grant_id}/license-key, sau đó event entitlement_grant.delivered sẽ được phát. Xem Manual Fulfillment. Đối với mọi integration khác, row được tạo với status: "Pending". Một event delivered hoặc failed sẽ được phát sau khi delivery hoàn tất:
  • Integration dựa trên OAuth (Discord, GitHub, Notion) chứa một oauth_url mà customer phải truy cập để hoàn tất việc cấp consent. Grant vẫn ở trạng thái Pending cho đến khi customer authorize.
  • Integration trực tiếp với platform (Telegram, Framer, Digital Files) chỉ ở trạng thái Pending trong thời gian ngắn khi platform call đang chạy, sau đó chuyển sang Delivered.
Quyền đã chuyển từ pending sang delivered. Khách hàng hiện có quyền truy cập như đã mô tả trong quyền. Sử dụng sự kiện này để mở khóa các tính năng phụ thuộc trong hệ thống của bạn, ví dụ để cung cấp một không gian làm việc, gửi email chào mừng tùy chỉnh hoặc đánh dấu một cờ “đã hoàn thành”. Grant đã chuyển từ Pending sang Delivered. Customer hiện có quyền truy cập được mô tả trong entitlement. Sử dụng event này để mở khóa các tính năng phụ thuộc trong hệ thống của bạn, chẳng hạn như provision một workspace, gửi email chào mừng tùy chỉnh hoặc đánh dấu cờ “fulfilled”. Trường delivered_at trong payload ghi nhận thời điểm delivery hoàn tất. Đối với các grant có trạng thái Delivered ngay khi được tạo, bạn sẽ nhận được các event createddelivered liên tiếp. Giao hàng đã được thử nghiệm nhưng thất bại với lỗi không thể thử lại. Các trường error_codeerror_message giải thích lý do thất bại. Nguyên nhân phổ biến bao gồm token OAuth bị thu hồi, quyền nền tảng bị từ chối, hoặc mục tiêu bị thiếu (ví dụ, một guild Discord đã bị xóa).
Xử lý entitlement_grant.failed như một hành động có thể thực hiện. Khách hàng đã thanh toán nhưng không nhận được quyền truy cập. Hiển thị các thất bại cho đội ngũ hỗ trợ của bạn hoặc kích hoạt lại sau khi vấn đề cơ bản được giải quyết.

entitlement_grant.revoked

Quyền truy cập đã bị rút lại ở cấp độ nền tảng: vai trò Discord bị xóa, cộng tác viên GitHub bị xóa, key giấy phép bị vô hiệu hóa, URL tải xuống tệp không còn được cấp phát. Trường revocation_reason ghi lại kích hoạt.

Biến Thể Payload

Trường data luôn là một đối tượng EntitlementGrantResponse. Hai kiểu tích hợp đính kèm thêm các đối tượng con: Trường data luôn là một object EntitlementGrantResponse. Payload chứa một trường integration_type (ví dụ license_key, digital_files, discord) để bạn có thể nhận diện trực tiếp loại grant. Ba loại integration cũng đính kèm các object nested bổ sung:
  • license_key được bao gồm khi integration_typelicense_key và một key đã được cấp. Object này chứa key được tạo, thời hạn hết hạn và thông tin sử dụng activation. Đối với grant được fulfillment thủ công vẫn ở trạng thái Pending, object này là null cho đến khi bạn fulfillment grant.
  • digital_product_delivery được bao gồm khi integration_typedigital_files. Object này chứa các URL download presigned, instructions tùy chọn và external_url tùy chọn.
  • feature được bao gồm khi integration_typefeature_flag. Object này chứa feature_typefeature_id của capability được grant cấp.
Đối với tất cả các loại integration khác (Discord, GitHub, Telegram, Figma, Framer, Notion), các field nested này là null; cấu hình liên quan được lưu trong entitlement, không phải trong grant.

Payload Ví Dụ

License key được giao (entitlement_grant.delivered)

Được phát khi customer mua một product có entitlement License Key sử dụng fulfillment_mode: manual. Grant ở trạng thái Pending và chưa có object license_key — merchant phải cung cấp key.

Quyền bị thu hồi khi hủy đăng ký (entitlement_grant.revoked)

Giao hàng thất bại (entitlement_grant.failed)


  • Chờ entitlement_grant.delivered trước khi mở khóa các tính năng phụ thuộc. Một sự kiện payment.succeeded cho bạn biết tiền đã được giải ngân; nó không cho bạn biết rằng khách hàng đã có repo GitHub hoặc vai trò Discord. Sự kiện delivered là nguồn sự thật cho việc thực hiện.
  • Lập bản đồ revocation_reason đến luồng giữ chân người dùng. Một quyền hồi lại subscription_on_hold thường có nghĩa là thẻ của khách hàng đã thất bại và lần gia hạn tiếp theo sẽ cấp lại quyền. Một quyền hồi lại manual hoặc subscription_cancelled là có chủ ý. Xử lý chúng khác nhau trong thông báo khách hàng.
  • Sử dụng quyền id như là khóa idempotency của bạn. Một quyền duy nhất phát ra nhiều nhất một sự kiện created và nhiều nhất một sự kiện cuối cùng (delivered hoặc failed), và nhiều nhất một sự kiện revoked. Các đợt giao lại từ hệ thống webhook có thể lặp lại các sự kiện; loại bỏ trùng lặp trên cấp quyền id cộng type.
  • Kiểm tra license_keydigital_product_delivery để nhận biết kiểu tích hợp. Bản thân tải trọng quyền không mang kiểu tích hợp, nhưng chính xác một trong các đối tượng con này được điền cho các quyền license-key và tệp kỹ thuật số.
  • Đối với các quyền dựa trên OAuth, hiển thị oauth_url cho khách hàng. Sự kiện entitlement_grant.created cho luồng thuê bao Discord, GitHub hoặc Notion bao gồm một oauth_urloauth_expires_at. Gửi email nó cho khách hàng hoặc hiển thị trong ứng dụng của bạn để giải phóng việc giao hàng.

Mẹo Tích Hợp

  • Chờ entitlement_grant.delivered trước khi mở khóa các tính năng phụ thuộc. Event payment.succeeded cho biết khoản tiền đã được xử lý thành công; event này không cho biết customer đã có GitHub repo hoặc Discord role hay chưa. Event delivered là nguồn dữ liệu chính thức cho fulfillment.
  • Map revocation_reason vào các flow retention. Việc revoke subscription_on_hold thường có nghĩa là thẻ của customer đã bị từ chối và lần renewal tiếp theo sẽ grant lại quyền truy cập. Việc revoke manual hoặc subscription_cancelled là có chủ ý. Hãy xử lý chúng khác nhau trong thông báo gửi customer.
  • Sử dụng id của grant làm idempotency key. Một grant chỉ phát tối đa một event created, tối đa một event kết thúc (delivered hoặc failed), và tối đa một event revoked. Hệ thống webhook có thể gửi lại event; hãy dedupe dựa trên id của grant cùng với type.
  • Đọc integration_type để nhận diện loại grant. Payload chứa trực tiếp integration_type (ví dụ license_key, digital_files, discord). Các object nested license_keydigital_product_delivery được điền sau khi các grant tương ứng được delivered; grant license key được fulfillment thủ công vẫn ở trạng thái Pending với integration_type: "license_key"null license_key cho đến khi bạn fulfillment grant.
  • Đối với các grant OAuth, hiển thị oauth_url cho customer. Event entitlement_grant.created cho flow subscriber của Discord, GitHub hoặc Notion chứa oauth_urloauth_expires_at. Gửi URL đó qua email cho customer hoặc hiển thị trong app của bạn để hoàn tất delivery.

Detailed view of a single entitlement grant: who it's for, its lifecycle state, and any integration-specific delivery payload.

brand_id
string
bắt buộc

Brand id this grant belongs to.

business_id
string
bắt buộc

Identifier of the business that owns the grant.

created_at
string<date-time>
bắt buộc

Timestamp when the grant was created.

customer_id
string
bắt buộc

Identifier of the customer the grant was issued to.

entitlement_id
string
bắt buộc

Identifier of the entitlement this grant was issued from.

id
string
bắt buộc

Unique identifier of the grant.

integration_type
enum<string>
bắt buộc

The integration type of the grant's entitlement (e.g. license_key).

Tùy chọn có sẵn:
discord,
telegram,
github,
figma,
framer,
notion,
digital_files,
license_key,
feature_flag
metadata
Metadata · object
bắt buộc

Arbitrary key-value metadata recorded on the grant.

status
enum<string>
bắt buộc

Lifecycle status of the grant.

Tùy chọn có sẵn:
Pending,
Delivered,
Failed,
Revoked
updated_at
string<date-time>
bắt buộc

Timestamp when the grant was last modified.

delivered_at
string<date-time> | null

Timestamp when the grant transitioned to delivered, when applicable.

digital_product_delivery
null | Digital Product Delivery · object

Digital-product-delivery payload, present when the entitlement integration is digital_files.

error_code
string | null

Machine-readable code reported when delivery failed, when applicable.

error_message
string | null

Human-readable message reported when delivery failed, when applicable.

feature
null | object

Typed feature payload, present only when the entitlement integration is feature_flag; null for every other integration type.

license_key
null | object

License-key delivery payload, present when the entitlement integration is license_key.

oauth_expires_at
string<date-time> | null

Timestamp when oauth_url stops being valid, when applicable.

oauth_url
string | null

Customer-facing OAuth URL for OAuth-style integrations. Populated during the customer-portal accept flow; null until the customer completes that step, and on grants for non-OAuth integrations.

payment_id
string | null

Identifier of the payment that triggered this grant, when applicable.

revocation_reason
string | null

Reason recorded when the grant was revoked, when applicable.

revoked_at
string<date-time> | null

Timestamp when the grant transitioned to revoked, when applicable.

subscription_id
string | null

Identifier of the subscription that triggered this grant, when applicable.

Lần sửa đổi cuối 21 tháng 8, 2026