API v1 ReferenceWebhooks

Returns all logs of the webhook with the specified id.

Returns all logs of the webhook with the specified id.

Required Permissions
The user must be an admin or have workspace-manage-config:read permissions.

Path parameters

webhookIdUUIDRequired

The id of the webhook to get the logs for.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

OK

messagestring or nullOptional

The message which has been sent to the webhook receiver.

webhookIdUUIDOptional

The id of the webhook.

responseCodeintegerOptional

The HTTP response code of the request.

createdOndatetimeOptional

The date the log was created.

reasonstring or nullOptional

The failure reason if the request failed.

isSuccessfulbooleanOptional

Whether the request was successful.