delete
https://api.adopay.com.br/v3/accounts/webhooks/
This API allows you to permanently delete a webhook. Once deleted, the webhook will no longer receive notifications, and the operation cannot be undone. Make sure you have the correct webhook ID before proceeding.
Headers
| Parameter | Type | Description | Example |
|---|---|---|---|
| Authorization | String | Bearer + Access_token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo |
Path Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| webhook_id | Integer | The ID of the webhook to delete. This is the ID returned when the webhook was created. | 789 |
Request Example
DELETE /v3/webhooks/789
Authorization: Bearer <access_token>
Response Details
{
"message": "Webhook deleted successfully"
}
| Field | Description |
|---|---|
| message | Confirmation message indicating the webhook was successfully deleted |
Error Responses
| HTTP Code | Error Message | Description |
|---|---|---|
| 400 | Account is closed | The webhook's associated account is closed. Cannot delete webhooks for closed accounts. |
| 401 | Unauthorized | Invalid or missing authentication token. Ensure you are sending a valid Bearer token. |
| 404 | Webhook not found | The webhook with the specified ID was not found or you do not have access to it. |
Business Rules
Authentication:
- Requires valid authentication token
- User must be authenticated and have access to the webhook
Validations:
- Webhook must exist and be accessible by the authenticated user
- Account cannot be closed
Deletion Behavior:
- Deletion is permanent and cannot be undone
- Once deleted, the webhook will immediately stop receiving notifications
- The webhook ID cannot be reused
- After deletion, you can create a new webhook with the same URL and type if needed
Best Practices:
- Before deleting, verify the webhook ID using the List Webhooks endpoint
- Document the reason for deletion in your change logs
- After successful deletion, the webhook will not appear in List Webhooks results
