Short answer
On every lead assignment (or optionally on lead creation), the webhook export automatically sends a JSON object to the URL you have stored. The object contains the lead's master data, all custom fields, information about the purchase and all attachments.
Detailed guide
With the webhook integration, you can transfer lead data in real time to your own system or a third-party system. As soon as a lead is assigned (or created), your webhook URL is called automatically.
How to set up a webhook
- Navigate to Settings > Integrations > Webhooks.
- Click Add webhook.
- Enter the target URL to which the data should be sent.
- Select the lead type (or “All lead types”).
- Select the trigger: After lead assignment or After lead creation.
- Activate the integration and save.
Structure of the payload
The data is transferred as JSON via a POST request. An example:
{
"id": 12345,
"lead_type_id": 7,
"gender": "male",
"first_name": "John",
"last_name": "Doe",
"company": null,
"street_no": "Hauptstraße 12a",
"zip_code": "10115",
"city": "Berlin",
"country_code": "DE",
"phone": "+49 170 1234567",
"email": "john@example.com",
"birth_date": "1985-04-12",
"roof_size": "85",
"energy_consumption": "4200",
"has_battery": "yes",
"lead_type_short_code": "PV",
"buyer_id": 42,
"buyer_price": "149.00",
"assignment_date": "2026-06-15T10:32:00.000000Z",
"attachments": [
{
"id": 988,
"field_name": "roof_photo",
"filename": "roof.jpg",
"mime_type": "image/jpeg",
"file_size": 284910,
"download_url": "https://...signed...",
"expires_at": "2026-06-15T10:37:00+00:00"
}
]
}
Fields included
- Master data: id, lead_type_id, gender, first_name, last_name, company, street_no, zip_code, city, country_code, phone, email, birth_date
- Custom fields: all fields of your lead type are included at the top level (e.g. roof_size, energy_consumption).
- Purchase and assignment data: lead_type_short_code, buyer_id, buyer_price (default “0.00”), assignment_date
- Attachments: list with id, field_name, filename, mime_type, file_size and, depending on the method, a download URL.
Further frequently asked questions
When is the webhook triggered?
By default, after every lead assignment. Alternatively, you can select “After lead creation”. For each webhook, you can additionally restrict it to a specific lead type.
Which custom fields are sent?
All custom fields of the respective lead type are automatically transferred at the top level of the payload. Manual mapping of individual fields is not required.
Can I send only public data?
Yes. Activate the “Public data only” option for the respective webhook. Then only the custom fields marked as public are transferred.
How are attachments transferred?
Attachments are passed in the attachments field. Depending on the setting, you receive a time-limited download URL (default), the file content as Base64 or a token-based download link. Download links have an expiry date (expires_at field).
Can I customise the field names?
Yes. Activate the data mapper in the webhook configuration. This allows you to rename or restructure the standard field names to your own target fields.
How can I check whether the request is genuine?
Every request contains a Signature header (HMAC-SHA256). This allows your system to verify the authenticity of the request. The secret key required for this is available on request from our support team.