Bulk Delete Webhook Events

DELETE 
/api/xero/webhook-settings/:integrationInstanceId/events

Permanently delete webhook events in bulk. This only removes the stored event records (the audit feed); it does not undo any data changes the events triggered. Requires an explicit confirmation value of YES.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Body (one of two selection modes):

• event_ids (array of integers, required unless apply_to_all is true): explicit event IDs to delete. Each ID must exist.
• apply_to_all (boolean, optional): when true, delete every event matching filters instead of an explicit ID list.
• filters (object, optional, used with apply_to_all): flat filter map using the same keys as List Webhook Events' filter[...] parameters, e.g. {"status": "duplicate"}.
• confirmation (string, required): must be exactly YES.

Returns the number of rows removed.

Authentication: Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.