How do I map webhook fields to record fields?

The Map Fields step decides which part of the payload goes into which field of the record. It uses the test payload your tool sent in the previous step. Your endpoints are in Settings → Webhooks.

Step by step

These steps are for Manual Mapping.

1. Open your endpoint from Settings → Webhooks → Manage receive endpoints. While you create an endpoint, the same table is the Map Fields step.
2. Open the Mapping tab.
3. If the payload holds a list, pick it in Record source: Breakcold creates one record per item, up to 100 per webhook. Keep Entire payload (single record) for one record per webhook.
4. Each row shows a Payload Field and its Sample Value. Open Map to Field and pick the Breakcold field.
5. Fields with an info icon are unique identifiers: map one so webhooks update existing records instead of creating duplicates. No field fits? Click Create new attribute.

During setup, AI suggests a first set of mappings: change them, then click Configure & Activate.

In Smart (AI) mode

The Map Fields step shows what the AI found in your test payload. To steer it, write AI Mapping Instructions, for example "Only extract the primary email.", then click Re-run AI. Later, edit them in the endpoint's Settings tab, under Smart mapping prompt.

Update records instead of duplicating them

Before creating a record, Breakcold looks for an existing one:

• with the Record ID, if you mapped a payload field to it (Manual Mapping only). The value must be the ID of a Breakcold record of the same object type;
• with any field marked as a unique identifier, such as Email or LinkedIn for people. In the Map to Field list, these fields have an info icon that reads "Unique identifier – used to match existing records".

If one record matches, it is updated. If none does, a record is created. If you click Configure & Activate without mapping either, a warning titled This import may create duplicates lists the fields to map. Click Go back to add one.

Good to know

• Owner: a webhook can only set the owner with the Breakcold user ID of a workspace member. An email or a name makes the delivery fail. When the owner isn't mapped, new records belong to the person who created the endpoint.
• Select fields match an option by its name. On select, multi-select and currency fields, Configure transformer sets value rules, a default option, the separator or the currency.
• A value that isn't a valid number or date is left out. A checkbox is ticked for true, 1 or yes.
• Changes on the Mapping tab apply to the next webhooks. Webhooks already received aren't processed again.

Related

• How to avoid duplicates with unique identifiers
• How to create a webhook receiver endpoint
• Why isn't my webhook creating records?