Skip to main content
Version: FINAL-1.0.0

How to start

To get started with this process, please make sure that you have all the information needed so our team can start your webhook configuration.

Information

Endpoint URL
The POST endpoint on your side were you want us to send every notification.
Endpoint Basic authentication credentials
The user and the password needed to connect to your endpoint, we encrypt this information before save.
List of user
List of Bunny Studio users that you want to track the notification with the webhook.
All formats
If you want us to send you all the formats of the deliverable. See below for more info..
Deliverable name
If you want us to send you the urls as and object with the deliverable name, or only a string with the URL. See below for more info.
Failure email
What email address we will sent an alert that there was and issue sending the notification to your endpoint.
Retry period of time
For how long do you want us to try to send the notification. See below for more info.
Only API
In you want us to only notify API projects or all the projects created related to your users
List of notifications
What type of notifications do you want us to send you. See the list of available notifications here.

After you have all this information get in contact with one of our representatives so we can start configuring the webhook for you.

All formats

When you want all the formats of the deliverable you will recive a notification where the URL's will show as follow:

"urls": {
"part001": {
"mp3": "URL.mp3",
"wav": "URL.wav",
}
}

If what you want is only the a specific format, you will recive the notification like this, example: Do you want only mp3 file:

"urls": {
"part001": "URL.mp3"
}

Deliverable name

If you want that we send you the URL with the deliverable name, we will send the notification like this:

example: You want all the files with the deliverable name:

"urls": {
"part001": {
"mp3": "URL.mp3",
"wav": "URL.wav",
}
}

example: You want only mp3 file with the deliverable name:

"urls": {
"part001": {
"mp3": "URL.mp3",
}
}

If instead you only want the URLs without the deliverable name it will send like this:

example: You want all the files without the deliverable name:

"urls": ["URL.mp3", "URL.wav"]

example: You want only mp3 file without the deliverable name:

"urls": "URL.mp3",

Retry system

We have a retry system that will try again for a period of time to send the notification to your endpoint in case the system dectects an error when sending it. It works with this rules:

  • Stage 1: It will try every minute for five minutes.

  • Stage 2: It will try every hour for the next 24 hours.

  • Stage 3: It will try every day for a period of time defined by you.

An e-mail will be sent, every time the system moves from one stage to the other.