Webhook
Create webhook
- Introduction
- API Reference
- GETList call outcomes
- GETList company categories
- GETList contract types
- GETList custom fields
- GETList industries
- GETList lead sources
- GETList loss reasons
- GETList market sectors
- POSTCreate opportunity
- PATCHUpdate opportunity
- GETList opportunities
- GETGet opportunity
- DELDelete opportunity
- GETList opp stages
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Opportunity
Opp Stage
Webhook
Create webhook
POST
/
api
/
2023-01
/
webhooks
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Authorization
string
*
Authorization
Required
string
object
webhook
object
webhook
object
url
string
*
url
Required
string
Add Example Value
description
string
description
string
Add Example Value
filter_types
array
filter_types
array
Add Example Value
secret
string
*
secret
Required
string
Add Example Value
rate_limit
integer
rate_limit
integer
Add Example Value
curl --request POST \
--url https://api.buildr.com/api/2023-01/webhooks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"webhook": {
"url": "https://example.com/webhook",
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
],
"secret": "secret",
"rate_limit": 100
}
}'
{
"webhook": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://example.com/webhook",
"version": 1,
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
]
}
}
Headers
Authorization
string
requiredBody
application/json
webhook
object
webhook.url
string
requiredwebhook.description
string
webhook.filter_types
enum<string>[]
Available options:
opportunity.create
, opportunity.update
, company.create
, company.update
, contact.create
, contact.update
webhook.secret
string
requiredwebhook.rate_limit
integer
Response
201 - application/json
webhook
object
requiredwebhook.id
string
requiredwebhook.url
string
requiredwebhook.version
integer
requiredwebhook.description
string
requiredwebhook.filter_types
enum<string>[]
requiredAvailable options:
opportunity.create
, opportunity.update
, company.create
, company.update
, contact.create
, contact.update
curl --request POST \
--url https://api.buildr.com/api/2023-01/webhooks \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"webhook": {
"url": "https://example.com/webhook",
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
],
"secret": "secret",
"rate_limit": 100
}
}'
{
"webhook": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://example.com/webhook",
"version": 1,
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
]
}
}