Note: Webhooks are currently in Beta. Contact Support to join the Beta release and activate this feature on your account.
Webhooks is a Pro feature that is only enabled on accounts that are subscribed to a Pro Membership plan.
1. What are Webhooks?
BriteBiz Webhooks allows an external application (such as Zapier or another SaaS application) to receive notifications about actions that occur in your BriteBiz account. These notifications include the type of action and the data of the associated record.
Webhooks are a way for you to keep another application that you use in sync with everything that happens in your BriteBiz account.
2. Webhooks & Zapier
If you use BriteBiz & Zapier, you can connect to over 7,000 apps. For a full list of Apps that you can connect with Zapier, click here.
3. How do I create a Webhook?
Webhooks can be accessed from the Integration section in your account settings (click here). To create a Webhook, simply click on the Create Webhook link.
First, give your webhooks a meaningful Name.
Next, enter the web address of the application or server (Destination Address) that will be notified when an action happens in your BriteBiz account.
Lastly, select the action(s) that you want the destination application to be notified about and click Create.
4. Webhook Data
When a webhook is sent to the destination server it will include a JSON payload of the related record, for example:
{"action_type":"update",
"object_type":"deal",
"object":{"id":"ABC123",
"reference":"B-ABC123",
"name":"Emily Jones - Wedding",
"type":"Wedding",
"stage_type": "confirmed",
"stage":"Booked",
"closed_date":"2024-08-16 12:25:00",
"start_date":"2028-06-18 16:00:00",
"end_date":"2028-06-18 23:00:00",
"description":"",
"owner":"Ann Smith",
"source":"Facebook",
"custom_fields":{"custom_field_name_1":"cf value one",
"custom_field_name_2":"cf value two"},
"contacts":[{"first_name":"Emily",
"last_name":"Jones",
"email":"emaily_jones@emailprovider.com",
"telephone":"",
"cell":"",
"type":"Bride",
"email_opt_out":"No",
"created":"2024-03-09 05:09:00",
"updated":"2024-06-21 14:22:00"}],
"created":"2024-07-19 15:23:00",
"updated":"2024-11-02 09:58:00"}}This payload will always include:
action_type: [create, update, delete]
object_type: [lead, deal]
object: [lead object, deal object]
The attributes in the object will always include the standard fields of this object, along with any custom fields and associated contact records.
5. Review your Webhook
Each time your Webhook is triggered, BriteBiz will record the action that triggered the Webhook, and the response from the Webhook destination. To view the most recent actions of your webhook, simply click on the Webhook history icon next to your webhook:
Webhook history will be maintained for 14 days.
The history records the action that triggered the Webhook, a link to the associated record (if it hasn't been deleted), and the HTTP response from the destination server.
6. Error Response from Destination Server
If BriteBiz receives an HTTP error code from the destination server, it may attempt to send the webhook again after a short delay. Webhooks will be retried up to 3 times. Webhooks will only be attempted again if BriteBiz receives one of the following HTTP codes from the destination server: 408, 425, 429, 500, 502, 503, 504.
7. Data Import, Mass Update, and Mass Delete
Webhooks will not be triggered during a data import, mass update, or mass delete.