Webhook Audit Logging

List webhook audit entries

Example Request:

curl "https://controller-host:8001/api/v2/audit/webhooks" \
	-X GET \
	-u u_jsmith@example.com_u0VmztKJrwqf:

Example Response:

{
    "entries": [
        {
            "id": 1,
            "uuid": "febdcc87-3454-467c-82b3-cfee4c4524c0",
            "url": "https://my-webhook-server:8443",
            "event": "translation.created",
            "timeTriggered": "2018-06-21 19:03:31.799810031Z",
            "timeLastAttempted": "2018-06-21 19:03:31.799810031Z",
            "data": {
                "translationId": "acaa78f3-d739-4002-b1f6-b5027244f6e9"
            },
            "errorMessage": "",
            "retryAttempts": 0
        }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "totalItems": 1
}

Retrieve a list of webhook audit entries

HTTP Request

GET /api/v2/audit/webhooks

Request Parameters

Name	Type	Description	Default Value
`url` (optional)	string	URL substring to filter by
`failed` (optional)	boolean	Failure status to filter by
`event` (optional)	string	Show only webhooks with the given comma-separated events. (see table of possible events)
`page` (optional)	int	Page number to return	`1`
`perPage` (optional)	int	Number of webhooks to return per page	`25`

Returns

Returns a list of webhooks as a WebhookAuditEntryList object with the following attributes.

Name	Type	Description
`entries`	array of objects	List of entries as an array of `WebhookAuditEntry` objects
`page`	int	Page number returned
`perPage`	int	Number of entries returned per page
`totalPages`	int	Total number of pages available
`totalItems`	int	Total number of webhooks

Retry webhook audit entry

Example Request:

curl "https://controller-host:8001/api/v2/audit/webhooks/1/retry" \
	-X PUT \
	-u u_jsmith@example.com_u0VmztKJrwqf:

Retry a webhook audit entry.

HTTP Request

PUT /api/v2/audit/webhooks/{id}/retry

Path Parameters

Name	Type	Description
`id`	int	Identifier of the webhook audit entry

Delete a webhook audit entry

Example Request:

curl "https://controller-host:8001/api/v2/audit/webhooks/1" \
	-X DELETE \
	-u u_jsmith@example.com_u0VmztKJrwqf:

Example Response:

{
    "id": 1,
    "uuid": "febdcc87-3454-467c-82b3-cfee4c4524c0",
    "url": "https://my-webhook-server:8443",
    "event": "translation.created",
    "timeTriggered": "2018-06-21 19:03:31.799810031Z",
    "timeLastAttempted": "2018-06-21 19:03:31.799810031Z",
    "data": {
        "translationId": "acaa78f3-d739-4002-b1f6-b5027244f6e9"
    },
    "errorMessage": "",
    "retryAttempts": 0
}

Delete a webhook audit entry.

HTTP Request

DELETE /api/v2/audit/webhooks/{id}

Path Parameters

Name	Type	Description
`id`	int	Identifier of the webhook audit entry

Returns

Returns the deleted WebhookAuditEntry object.

Name	Type	Description
`id`	int	Identifier of the webhook audit entry
`uuid`	string	Identifier of the associated webhook
`url`	string	URL the webhook attempted to post to
`event`	string	Event that triggered the webhook
`timeTriggered`	string	The initial time the webhook was triggered
`timeLastAttempted`	string	The latest time the webhook audit entry was retried
`data`	string	The data to be posted to the remote server
`errorMessage`	string	The reason for the failed attempt (if applicable)
`retryAttempts`	int	How many times this webhook audit entry has been retried