Frequently Asked Questions (FAQs)

Business requirement: multiple subscription modes need to be supported to meet different user needs 1. Three subscription modes are supported: - Global subscription: subscribes to events of all related resources. After the primary account subscribes, all sub-accounts are automatically subscribed by default - Subscribe by user: specific object_ids must be provided, i.e. the user IDs - Subscribe by questionnaire: specific object_ids must be provided, i.e. the questionnaire IDs 2. Configuration rules: - Except for global subscription, all other subscription modes must include the corresponding object_ids - When subscribing by user, the create questionnaire event does not need object_ids - When subscribing by questionnaire, the create questionnaire event cannot be included

Business question: Need to clarify the supported event types and their specific scope 1. Supports 7 event types: - Create survey - Modify survey (only question edits, excluding survey setting changes) - Delete survey - Response completed - Response updated - Response deleted - Response invalid (returns the reason for invalidity)

Business issue: The length of the authorization field needs to be controlled to ensure security Business rule: - The authorization field length is limited to 0-512 characters

Business issue: Need to ensure the reliability of webhook callbacks Business rules: 1. Retry up to 5 times 2. Retry intervals: - 1st retry: 10 seconds - 2nd retry: 1 minute - 3rd retry: 5 minutes - 4th retry: 30 minutes (send a reminder email about the push failure) - 5th retry: 1 day (send a reminder email about push being disabled)

Business issue: You need to handle consecutive failures and notify the user Business rules: 1. The system automatically sets all webhooks with the same URL to disabled 2. Sends an email notification to the user (the email will be sent to the primary account) 3. Saves the failure records to a separate queue with the webhook id as the key (retained for 7 days) 4. Allows the user to backfill the data within 7 days

Business issue: events need to be handled during the period when the webhook is disabled 1. Event records within 7 days after disabling are stored in a separate queue 2. If the number of disablements exceeds 1, contact technical support 3. After it is re-enabled, the queued data will be pushed proactively

Business question: webhook call logs need to be recorded for troubleshooting Business rules: - The callback needs to include Alibaba Cloud log records in JSON format

Business issue: duplicate webhook configurations must be prevented Business rules: 1. The following field combination must be unique: - subscription_model (subscription mode) - event_type (event type) - object_ids (object IDs) - url_subscription (subscription URL) 2. Exception: using the same url_subscription for different events is not restricted

Business question: A unified time format is required, along with a resource access link. Business rules: 1. Event Time returns a millisecond-level timestamp. 2. The push parameters include a resource access URL.

Business question: It is necessary to clarify the webhook status types and their impact Business rules: webhook status is divided into four types: 1. Historical data (status=0) 2. Available (status=1) 3. Unavailable (status=2, no push) 4. System disabled (status=3, multiple callback failures)