Get webhook logs

GET /api/2.0/settings/webhooks/log

Request

Returns the logs of the webhook activities.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

deliveryFromstringformat: date-time

Delivey start time

deliveryTostringformat: date-time

Delivey end time

hookUristring

Hook URI

webhookIdintegerformat: int32

Webhook ID

configIdintegerformat: int32

Config ID

eventIdintegerformat: int32

Event ID

groupStatusone of

Webhook group status

.enum of string

[None - None, NotSent - Not sent, Status2xx - Status2xx, Status3xx - Status3xx, Status4xx - Status4xx, Status5xx - Status5xx]

Can be one of: None, NotSent, Status2xx, Status3xx, Status4xx, Status5xx.

.enum of integer

[0 - None, 1 - Not sent, 2 - Status2xx, 4 - Status3xx, 8 - Status4xx, 16 - Status5xx]

Can be one of: 0, 1, 2, 4, 8, 16.

Examples

GET /api/2.0/settings/webhooks/log?deliveryFrom=2008-04-10T06%3A30%3A00.0000000%2B04%3A00&deliveryTo=2008-04-10T06%3A30%3A00.0000000%2B04%3A00&hookUri=some%20text&webhookId=1234&configId=1234&eventId=1234 HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/settings/webhooks/log?deliveryFrom=2008-04-10T06%3A30%3A00.0000000%2B04%3A00&deliveryTo=2008-04-10T06%3A30%3A00.0000000%2B04%3A00&hookUri=some%20text&webhookId=1234&configId=1234&eventId=1234' \
  --header 'Accept: application/json'

Responses

200

Logs of the webhook activities

idintegerformat: int32

ID

configNamestring

Config name

creationTimestringformat: date-time

Creation time

methodstring

Method

routestring

Route

requestHeadersstring

Request headers

requestPayloadstring

Request payload

responseHeadersstring

Response headers

responsePayloadstring

Response payload

statusintegerformat: int32

Status

deliverystringformat: date-time

Delivery time

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).