Webhooks
Webhooks allow your other systems to receive real-time notifications about events happening on our platform. We use Svix as our webhook provider to ensure reliable delivery and security.
How Webhooks Work
At their core, webhooks are POST requests sent to your specified endpoint whenever an event occurs on our platform. When an event happens, we'll send a JSON payload to your endpoint containing the event details.
During development, you can use the Svix Play webhook debugger to inspect and test your webhook integration. For detailed documentation about webhook implementation, security best practices, please refer to the Svix documentation.
Getting Started
- Add an Endpoint: Include the endpoint URL, provide an optional description, and select the events you want to subscribe to.
- Configure Advanced Endpoint Settings: Set up custom headers and transformations for the payload as needed.
- Handle the Webhook: Integrate the webhook into your application/system to start receiving real-time notifications.
For security reasons, we strongly recommend verifying webhook signatures to ensure requests are coming from our platform.
Automation Tools
You can handle webhooks using automation platforms that transform event payloads into the required format and transmit the data to your other systems. Automation platforms like Zapier or Make.com offer numerous integrations with other systems, catering also to non-developers. You can utilize an endpoint from an automation platform to receive events from branchly and then handle all logic and transformations there.
Event Catalog
form.submitted: Triggered when a user submits a form via one of our user interfaces.