---
title: Vendor Mapping
slug: docs/vendor-mapping
createdAt: 2026-07-07T06:40:53.322Z
---

A **Vendor** ingest creates or updates a Vendor (exhibitor, sponsor, or partner) in an event from a JSON payload — usually a webhook from your CRM or exhibitor system. It's a small, flat mapping: copy it, point the paths at your own payload, and you're done.

## How it works

A **field map** is a list of rules. Each rule reads a value from your payload (keyMatch) and writes it to a Jomablue Vendor field (type). Point each keyMatch at wherever the value lives in your own payload, using dot notation (e.g. vendor.primaryContact.email).

Vendors are matched by **resource\_id** first, then by **organisation\_uid**. If neither matches an existing Vendor, a new one is created. New Vendors must have a **name**. Anything in the payload that no rule references is ignored.

## The mapping

:::BlockQuote
\[
&#x20; \{ "type": "resource\_id", "keyMatch": "resource\_id" },
&#x20; \{ "type": "organisation\_uid", "keyMatch": "organisation\_uid" },
&#x20; \{ "type": "name", "keyMatch": "name" },
&#x20; \{ "type": "display\_name", "keyMatch": "display\_name" },
&#x20; \{ "type": "description", "keyMatch": "description" },
&#x20; \{ "type": "active", "keyMatch": "active" },
&#x20; \{ "type": "email\_domain", "keyMatch": "email\_domain" },
&#x20; \{ "type": "website", "keyMatch": "website" },
&#x20; \{ "type": "primary\_contact\_first\_name", "keyMatch": "primary\_contact.first\_name" },
&#x20; \{ "type": "primary\_contact\_last\_name", "keyMatch": "primary\_contact.last\_name" },
&#x20; \{ "type": "primary\_contact\_email", "keyMatch": "primary\_contact.email" }
]
:::

## The fields

**resource\_id** — the Vendor's internal ID, and the primary way Vendors are matched. Accepts a plain integer or a formatted string like app\_name/vendor/123 (the trailing number is used).

**organisation\_uid** — your own identifier for the vendor. Used for matching when there's no resource\_id, and stored on the Vendor either way.

**name** — the Vendor name. Required to create a new vendor.

**display\_name** — the name shown publicly. Defaults to name for new Vendors if you don't provide it.

**description** — a description of the vendor.

**active** — whether the Vendor is active. Accepts true, 1, "yes", "true", "1" (case-insensitive); anything else is false. New Vendors default to active if you don't map this.

**email\_domain** — the Vendor's email domain (e.g. northwindlabs.com).

**website** — the Vendor's website URL.

**primary\_contact\_first\_name / primary\_contact\_last\_name / primary\_contact\_email** — the Vendor's main point of contact. In the example these read from a nested primary\_contact object in the payload.

## Worked example

**Payload:**

:::BlockQuote
\{
&#x20; "resource\_id": "expo/vendor/58",
&#x20; "organisation\_uid": "VENDOR-58",
&#x20; "name": "Northwind Labs",
&#x20; "display\_name": "Northwind",
&#x20; "description": "Cloud tooling for event teams.",
&#x20; "active": true,
&#x20; "email\_domain": "northwindlabs.com",
&#x20; "website": "https\://northwindlabs.com",
&#x20; "primary\_contact": \{
&#x20;   "first\_name": "Sam",
&#x20;   "last\_name": "Okafor",
&#x20;   "email": "sam.okafor\@northwindlabs.com"
&#x20; }
}
:::

**Result:** Vendor 58 (matched by resource\_id, else created) named "Northwind Labs", shown as "Northwind", active, with the given description, email domain, and website, and a primary contact of Sam Okafor. Send the same resource\_id again with new values and the Vendor is updated in place.

## Validation

You can validate the payload before it's mapped. Each rule targets a payload key and applies one or more checks separated by |; a payload that fails is rejected before anything is created.

:::BlockQuote
\{
&#x20; "resource\_id": "required\_without\:organisation\_uid",
&#x20; "organisation\_uid": "required\_without\:resource\_id|string",
&#x20; "name": "required|string",
&#x20; "primary\_contact.first\_name": "nullable|string",
&#x20; "primary\_contact.last\_name": "nullable|string",
&#x20; "primary\_contact.email": "nullable|email"
}
:::

- **required\_without** — at least one identifier is needed. resource\_id is required only when organisation\_uid is absent, and vice versa.
- **required** — name must be present to create a vendor.
- **nullable** — checked only when present: the contact name fields must be strings, and the contact email must be a valid email.

Match these keys to your own payload paths.
