Webhooks
Webhooks allow you to keep track of your data without having to constantly poll our APIs for updates.
Webhook Object
You can Create and Delete webhooks through our Dashboard. We are working to expand this feature, so stay tuned for updates.
Attribute | Type | Description |
|
| The type of Event. Can be from any of the event type list (see below). |
|
| The URL to call when the Webhook is triggered. |
|
| A SHA-256 secret used to secure the Webhook communication. |
|
| Sets if related Event is dispatched. Default is |
|
| Whether the Webhook is deleted. Default is |
|
| Whether the Webhook endpoint is verified. Default is |
Receive Webhook
Changes since API version 2019-02-01
2019-08-15 - Headers renamed
We are deprecating the old headers, which means it is not a breaking change but it's recommended to update them as soon as possible.
X-Share-Webhook-Signature
becomesX-BuiltOn-Webhook-Signature
X-Share-Webhook-Type
becomesX-BuiltOn-Webhook-Type
Key | Description |
| Verifies that the incoming requests are legitimate, you should hash the response body with the SHA-256 secret and verify that it matches the |
| Two types that describe the nature of the webhook:
|
| How many times BuiltOn tried to send a webhook to your endpoint. BuiltOn will try to send 5 times. After the limit is reached, the retrying process will stop. |
Create a Webhook through the Dashboard
Go to the Webhooks and click New webhook +.
FIll in the
event_type
and theendpoint
.Go use your new webhook.
Attribute | Type | Description |
|
| The type of Event. |
|
| The URL to call when the webhook is triggered. |
Delete a Webhook through the Dashboard
Go to Webhooks and click the webhook you want to delete. You should see 'Delete webhook' below its details.
Click the X and confirm you want to delete it.
Mourn your deleted webhook.
Event Types
Event Type | Description |
| Order created |
| Order updated |
| Order cancelled |
| User created |
| User updated |
| User deleted |
| Subscription created |
| Subscription updated |
| Subscription deleted |
| Subscription activated |
| Subscription postponed |
| Subscription completed |
| Subscription stopping the next cycle |
| Subscription cancelled |
| Payment created |
| Payment updated |
| Payment deleted |
| Payment succeeded |
| Payment processing |
| Payment failed |
| Payment captured |
| Payment cancelled |
| Payment pending |
| Payment requires an authentication action |
| Product created |
| Product updated |
| Product deleted |
| Plan created |
| Plan updated |
| Plan deleted |
| ML model created |
| ML model training is ready to start |
| ML model is starting the training process |
| ML model has started and is currently being training |
| ML model has failed to train |
| ML model succeeded the training process |
| ML model couldn't start the training process, because there is no sufficient data |
| ML model evaluation is available |
Admin Role
Create a Webhook
Body Parameters | Type | Description |
|
| The type of event to receive information about. |
|
| The URL to call when the Webhook is triggered. |
|
| Sets if related Event is dispatched. Default is |
Verify a Webhook
The Webhook has to be verified before related data on related Events are dispatched. The API tries to verify the endpoint when the Webhook is created. If the endpoint returns an HTTP status code 2XX then the Webhook is set to verified
.
If an endpoint is updated, then the Webhook is not verified anymore. It is possible to manually try to verify the endpoint by doing the following request.
Body Parameters | Type | Description |
|
| ID of the webhook to be verified. |
Simulate a Webhook
It is possible to simulate the response from a Webhook to check the format of the data. The API will trigger a fake event related to the Webhook type and send the data to the specified endpoint.
Body Parameters | Type | Description |
|
| ID of the webhook to be simulated. |
Update a Webhook
Note that if the endpoint
is updated, then you will need to verify the webhook before related Events are dispatched.
Body Parameters | Type | Description |
|
| The type of event to receive information about. |
|
| The URL to call when the Webhook is triggered. |
Receive Webhook by ID
Path Parameters | Type | Description |
|
| ID of the Webhook to receive. |
Get All Webhooks
Delete a Webhook
Path Parameters | Type | Description |
|
| The ID of the Webhook to delete. Attribute |
Last updated