Webhook
List webhooks
- 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
List webhooks
GET
/
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
curl --request GET \
--url https://api.buildr.com/api/2023-01/webhooks \
--header 'Authorization: <authorization>'
{
"webhooks": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://example.com/webhook",
"version": 1,
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
]
}
]
}
Headers
Authorization
string
requiredResponse
200 - application/json
webhooks
object[]
requiredwebhooks.id
string
requiredwebhooks.url
string
requiredwebhooks.version
integer
requiredwebhooks.description
string
requiredwebhooks.filter_types
enum<string>[]
requiredAvailable options:
opportunity.create
, opportunity.update
, company.create
, company.update
, contact.create
, contact.update
curl --request GET \
--url https://api.buildr.com/api/2023-01/webhooks \
--header 'Authorization: <authorization>'
{
"webhooks": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://example.com/webhook",
"version": 1,
"description": "Webhook endpoint",
"filter_types": [
"opportunity.create"
]
}
]
}