Configuration
Overview
You can configure webhook endpoints via the API to be notified about events that happen in your RemoveBounce account.
Requirements
You need an active RemoveBounce account. If you don't have an account with us yet, please go to our registration page and sign up easily using a social media account or by filling in the form.
Navigate to Webhook subscriptions
Please navigate to your dashboard and sign in to your account.
On the left sidebar, within the API section, please locate the Manage link and click on it.
Add your endpoint
On the webhook subscriptions section, click the Add an endpoint button.
Input the URL of your endpoint, then click the Save button.
The URL must be HTTPS and should accept an HTTP POST
request.
For local development, we recommend using a tool such as ngrok, in order to expose your local
endpoint (i.e. localhost/endpoint
) to RemoveBounce.
After you successfully saved a new endpoint, it will appear in the webhook subscriptions section.
Events we send to you
Event name | Type | Description |
---|---|---|
list:started | string | This event will be sent when your email list has started cleaning |
list:completed | string | This event will be sent when your email list has finished cleaning |
Retries
Your webhook must return a 2xx HTTP STATUS
quickly.
In the unfortunate event that your webhook subscription is unreachable (i.e. 3xx
, 4xx
, 5xx
),
we will retry to send you the event 5 times
. The retry schedule is as follows:
- First retry after
1 minute
- Second retry after
10 minutes
- Third retry after
20 minutes
- Forth retry after
1 hour
- Fifth retry after
3 hours
If after the fifth retry attempt, your webhook is still unreachable, the request will be dropped. In this case, please contact us.