Get Webhook List

API Overview

• Function: Get the list of created webhooks
• Request Method: GET
• Request URL: /api/surveys/{survey_id}/webhooks?appid={appid}&access_token={access_token}

Request Parameters

Parameter Name	Type	Location	Description	Example
survey_id	integer	uri	Survey ID	292190

Response Parameters

Parameter Name	Type	Description
total	integer	Number of webhook configurations
list	array[object]	Webhook list
list[_].id	integer	Auto-increment ID
list[_].url	string	URL
list[_].is_active	bool	Enable status
list[_].created_at	datetime	Creation time
list[_].updated_at	datetime	Modification time

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
        "list": [
            {
                "id": 51,
                "user_id": 0,
                "object": "Survey_292197",
                "url": "https://stage.wesurvey.com",
                "secret": "",
                "is_active": false,
                "options": "{\"listenedResources\":[\"answer\"]}",
                "created_at": "2021-07-22 16:46:56",
                "updated_at": "2021-07-22 16:56:00"
            }
        ],
        "total": 1
    },
    "request_id": "6b17fcf0-c08a-4311-8297-db7338cd49a1"
}

• Failed Request

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

Error Codes

error.type Error Code	Description
not_found	Data not found
invalid_argument	Parameter validation failed