Delete Webhook Event

The Delete Webhook Event endpoint allows merchants to soft delete a webhook event from their records. This means that while the event is marked as deleted and will no longer be active or visible in the primary event logs, it is not permanently removed from the database. This approach helps merchants manage their data storage and keep their event logs clean and relevant by marking outdated or unnecessary entries as deleted.

When a webhook event is soft deleted, all associated data, including response details and metadata, remain in the database but not visible. This ensures that the system's storage is optimized and that merchants only retain the most critical and up-to-date information in their active logs. Soft deleting irrelevant or old events can also improve the performance of the list and retrieve endpoints by reducing the volume of data processed.

Importantly, soft deleting a webhook event does not affect the configuration of the webhook URL or the ability to receive future events. Merchants can continue to receive and manage new events as usual. Additionally, soft-deleted events can be restored if needed, allowing merchants to recover any mistakenly deleted data.
DELETE/webhooks/webhook_events/{id}
Sandbox: https://api.payiano.dev/v1/webhooks/webhook_events/{id}
Live: https://api.payiano.com/v1/webhooks/webhook_events/{id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission webhook_events_delete
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each webhook event which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every webhook event. This ULID is automatically created by our system and is used to uniquely identify and track each webhook event in our database.

Query parameters:
force_delete
Type: boolean
Default: false

This attribute determines the deletion method to be applied to the webhook event delete in the database. When the value is set to true, it indicates that the webhook event should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the webhook event is not physically removed from the database. With Soft Delete it's still possible to restore the webhook event record.

Response
200
Response schema:
application/json
Response body:
status
Type: boolean

This value indicates whether the webhook event delete was successful or not.

Response sample:
1
{ 2 "status": true 3}