Webhook lead action - OgnianApostolov/builderly-api-docs GitHub Wiki
Model
LeadWebhook lead_webhook: {
"firstname": {
"type": "string",
"required": "true"
},
"lastname": {
"type": "string",
"required": "true"
},
"email": {
"type": "string",
"required": "true"
},
"phone_number": {
"type": "string",
"required": "true"
},
"address": {
"type": "string",
"required": "true"
},
"city": {
"type": "string",
"required": "true"
},
"state": {
"type": "string",
"required": "true"
},
"country": {
"type": "string",
"required": "true"
},
"zip_code": {
"type": "string",
"required": "true"
},
"notes": {
"type": "string",
"required": "true"
},
"company_name": {
"type": "string",
"required": "true"
},
"tax_identification_number": {
"type": "string",
"required": "true"
},
"lifetime_value": {
"type": "number",
"required": "true",
},
"addToNewsletter": {
"type:": "number",
"required": "true"
}
}
Method
Create new
POST 'https://{{your-builderly-domain}}/webhook/lead'
req.body required
method: 'POST'
{
url: 'https://{{your-builderly-domain}}/webhook/lead',
headers: {
'X-API-KEY': api_key
},
json: true,
body: webhook_lead
}
Responses
Success - status 201
{ webhook_lead}
Error - status 400
{
error_message
}