Remove webhook backoff

Use this endpoint to remove the penalty from an already registered webhook.

This endpoint allows you to remove the backoff penalty applied to a webhook configuration.

When a webhook experiences consecutive delivery failures, protection mechanisms may temporarily reduce the frequency of delivery attempts. Removing the penalty restores the normal notification flow.

The request uses the webhook configuration identifier (id) in the endpoint:

POST /v3/webhooks/{id}/removeBackoff

When to use this endpoint

This endpoint should be used when:

  • the webhook synchronization queue has been penalized due to recurring failures;
  • the application responsible for receiving events is operating normally again;
  • the unavailability of the destination URL has been resolved;
  • you want to restore event delivery without recreating the webhook;
  • temporary infrastructure issues have been fixed.
📘

Important

It is recommended to remove the penalty only after correcting the root cause of the synchronization failures.


Dependencies for use

Before removing the penalty, it is necessary that:

  • there is an active Asaas account;
  • the request is authenticated using a valid API Key;
  • the webhook configuration belongs to the authenticated account;
  • the configuration identifier (id) is available;
  • the receiving application is ready again to process incoming events.

Without these conditions, the operation may fail.


Important rules

This operation removes the penalty applied to the webhook configuration.

To perform the operation:

  • the configuration must exist;
  • the request must be authenticated;
  • the provided identifier must correspond to a webhook belonging to the authenticated account;
  • it is recommended to verify the availability of the configured URL beforehand.

If the root cause of the failures has not been fixed, new penalties may occur.


Operation behavior

After removing the penalty:

Penalized webhook
↓
Application fixed
↓
Penalty removed
↓
Normal delivery flow restored
↓
New events are delivered again

This operation does not recreate previously lost events nor modify webhook settings.

It only removes the penalty applied to the delivery mechanism.


Operational impacts

Removing the penalty allows events to be delivered normally again.

If the application remains unavailable:

  • new failures may occur;
  • the queue may be penalized again;
  • synchronization between systems may continue to be affected.

For this reason, it is recommended to fully validate the infrastructure before performing the operation.


Parameters used

ParameterDescription
idUnique identifier of the webhook configuration

Headers used

HeaderDescription
access_tokenAPI Key used to authenticate the request
Content-TypeRequest content type

Response codes

CodeDescription
204Penalty removed successfully
400Invalid request
401Invalid or missing API Key
404Webhook configuration not found

Request example

POST /v3/webhooks/wh_123456789/removeBackoff
Host: api.asaas.com
access_token: $YOUR_API_KEY
Content-Type: application/json

Response example

HTTP/1.1 204 No Content

Common errors

Webhook configuration not found

Occurs when the provided identifier does not exist or does not belong to the authenticated account.

Invalid API Key

Occurs when the request is sent without valid authentication.

Penalty occurs again

This may happen when the application responsible for receiving events remains unavailable.

📘

Recommended

Before removing the penalty, validate the application's availability and monitor event processing logs.


Related content

Depending on the integration requirements, the following content may complement the implementation:

  • Create new webhook;
  • List webhooks;
  • Retrieve a webhook;
  • Update existing webhook;
  • Remove a webhook;
  • Webhooks Guide;
  • API Authentication.

Path Params
string
required

Unique webhook configuration identifier

Body Params
Responses
204

No Content

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json