Delete Webhook

GET https://api.somossimpay.com.br/v3/accounts/api/webhooks/{webhook_id}

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
hmac	String	HMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6

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

HTTP

DELETE /api/webhooks/789

Response Details

Response

{
  "message": "Webhook deleted successfully"
}

Field	Description
message	Confirmation message indicating the webhook was successfully deleted

Error Responses

HTTP Code	Error Message	Description
400	Company not found	The authenticated company was not found in the system. Verify your authentication token.
400	Account is closed	The webhook's associated mirror account is closed. Cannot delete webhooks for closed accounts.
404	Webhook not found	The webhook with the specified ID was not found, does not belong to your company, or your user does not have an active policy for the associated account.

Validations:

• Webhook must exist and belong to the authenticated company
• User must have an active policy for the webhook's associated mirror account (returns 404 Webhook not found if not)
• 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

Security:

• Account and policy validation prevents users from deleting webhooks they don't have access to
• Attempting to delete a webhook from a different account or without an active policy will result in a 404 error

Best Practices:

• Before deleting, verify the webhook ID using the List Webhooks endpoint
• Consider temporarily disabling a webhook by updating its URL to a test endpoint instead of deleting it
• Document the reason for deletion in your change logs
• If you plan to recreate a similar webhook, note down its configuration before deletion

Post-Deletion:

• After successful deletion, the webhook will not appear in List Webhooks results
• Any in-flight notifications to this webhook may still be delivered
• The deletion does not affect other webhooks on the same account
• You can immediately create a new webhook with the same configuration if needed