KB Newsman
Newsman Api Method: webhook.getListWebhook
Prototype: webhook.getListWebhook(list_id)
Description: Returns a hash array with the webhook settings of a list
HTTP method: GET
Endpoint HTTP: /webhook.getListWebhook.json
Endpoint XML-RPC: webhook.getListWebhook
Return type: struct
Request parameters GET
| Variable | Type | Description |
|---|---|---|
| list_id | int|string | The ID of the list for which to get the settings |
Response parameters
| Parameter | Description |
|---|---|
| webhook_url | The webhook url of the list (null if missing) |
| events | The webhook events of the list (null if missing) |
Output example
{ "webhook_url": "null", "events": "null" }
Response Errors
| Code | Message | Description |
|---|---|---|
| 407 | Missing required param list_id | list_id param is required |
| 101 | Not allowed for list_id = %s | Invalid access to list_id |
Error examples
{ "err": true, "message": "Missing required param list_id", "code": 407 }