Form Webhooks
Use Basin to repost submission data to other apps and services.
Configuring a webhook
If you only need to forward submission data to a single app or service, then a custom webhook is a great solution. To setup a custom webhook in Basin, go to theIntegrationspage in your form dashboard, enter your desired URL in the input field, save, and you're all set!
When a submission is received by an endpoint with a configured webhook URL, Basin will queue up a post on your behalf. If the webhook fails, we will retry up to 15 times over the course of 24-28 hours with an exponential backoff. The format of our webhooks will be exactly what we receive on the inital form submission.
Form Webhook API
Create, Update, Delete, List, and Show your Webhooks.
Webhook API Actions
Action | Method | Path |
---|---|---|
List | GET | /api/v1/form_webhooks |
Show | GET | /api/v1/form_webhooks/:id |
Create | POST | /api/v1/form_webhooks |
Update | PUT | /api/v1/form_webhooks/:id |
Delete | DELETE | /api/v1/form_webhooks/:id |
List webhooks
You can return a list of your webhooks.
Argument | Options |
---|---|
query (string, optional) | Filter your webhooks by name, id, url, or associated form_id |
page (integer, optional) | Change the page |
Example API call
https://usebasin.com/api/v1/form_webhooks?filter_by=All&page=1&query=&api_token={account_api_token}
Make sure you swap out {account_api_token}
with your account wide API token found on your Account Setting page.
Show/Delete a webhook
You can return the attributes of a single webhook or delete a webhook using its id.
Argument | Options |
---|---|
id (integer) | The the webhook with this id |
Example API call
https://usebasin.com/api/v1/form_webhooks/{form_webhook_id}?api_token={account_api_token}
Make sure you swap out {account_api_token}
with your account wide API token found on your Account Setting page.
Create/Update a webhook
The following attributes are available to you.
Attribute | Type | |
---|---|---|
name | string | |
url | string | The url for the webhook |
format | string | Format for the payload to be sent in.Valid options are:form_url_encoded, json, slack, zapier_2_0_1, data_json, discord |
trigger_when_spam | boolean | Whether to trigger the webhook for submissions marked as spam. |
enabled | boolean | Enable/Disable the webhook. |
Example API call
https://usebasin.com/api/v1/form_webhooks?api_token={account_api_token}{"webhook":{"name":"webhookname",...}}
Make sure you swap out {account_api_token}
with your account wide API token found on your Account Setting page.