Create Webhook

API Overview

• Function: Premium users can push collected data in real-time to a specified URL, see Data Push for details
• Request Method: POST
• Request URL: /api/surveys/{survey_id}/webhooks?appid={appid}&access_token={access_token}

Request Parameters

Parameter Name	Type	Required	Location	Description	Example
survey_id	integer	Yes	uri	Survey ID	292190
url	string	Yes	body	URL for data push, note that this address must accept POST requests	https://wesurvey.com
is_active	bool	Yes	body	Enable status (true: enabled, false: disabled)	true

Response Parameters

Parameter Name	Type	Description
id	integer	Auto-increment ID
url	string	URL
is_active	bool	Enable status
created_at	datetime	Creation time
updated_at	datetime	Modification time

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
        "id": 42,
        "user_id": 1411902221,
        "object": "Survey_292190",
        "url": "https://wesurvey.com/",
        "secret": "open_test",
        "is_active": true,
        "options": "{\"listenedResources\":[\"answer\"]}",
        "created_at": "2021-06-21 16:02:33",
        "updated_at": "2021-06-21 16:02:33"
    },
    "request_id": "e4b27037-d876-427d-95c7-d5a737dd1677"
}

• Failed Request

{
    "code": "InvalidArgument",
    "error": {
        "type": "invalid_argument_url",
    },
    "data": {},
    "request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"
}

Error Codes

error.type Error Code	Description
permission_denied	No creation permission
invalid_argument_url	Invalid URL
invalid_argument	Parameter validation failed
resource_exhausted	Creation limit exceeded
create_error	Failed to create webhook