Webhook
Create webhook
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Project Stages
Task List
Webhook Message
Webhook
Create webhook
POST
/
api
/
2023-01
/
webhooks
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": [
"project.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": [
"project.create"
]
}
}
Headers
Body
application/json
Example:
"https://example.com/webhook"
Example:
"secret"
Example:
"Webhook endpoint"
Available options:
project.create
, project.update
, company.create
, company.update
, contact.create
, contact.update
Example:
["project.create"]
Example:
100
Response
201 - application/json
Created Response
Example:
"123e4567-e89b-12d3-a456-426614174000"
Example:
"https://example.com/webhook"
Example:
1
Example:
"Webhook endpoint"
Available options:
project.create
, project.update
, company.create
, company.update
, contact.create
, contact.update
Example:
["project.create"]
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": [
"project.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": [
"project.create"
]
}
}