Vendors
Use a Vendor-type ingest endpoint to create and update vendor (exhibitor/sponsor) records within an event. This enables third-party systems - such as CRMs, sponsorship management platforms, or partner portals - to programmatically manage vendor data in Jomablue.
Typical use cases include:
- Syncing vendor/exhibitor records from a CRM or sponsorship management system
- Creating vendor records ahead of an event from an external partner database
- Updating vendor contact details and display information as they change upstream
How It Works
Vendor ingest works the same way as People and Session ingest: you send a JSON payload to the ingest endpoint, and Jomablue maps the fields based on the endpoint's configured mapping rules. The endpoint, authentication, rate limits, and request format are identical - the only difference is that the endpoint is configured as a Vendor type, and the mapped fields correspond to vendor attributes.
Existing vendors can be matched using a resource_id (either a formatted identifier as used in the Updates API, or a direct integer record ID). If no match is found, a new vendor record is created.
Mapped Fields
The following fields are available for mapping within a Vendor ingest endpoint:
Field | Type | Notes |
|---|---|---|
resource_id | String | Formatted identifiers (e.g. acme/vendor/123) generate by Jomablue. Used for matching existing vendors. |
organisation_uid | String | An external unique identifier for the vendor. |
name | String | The vendor's name. |
display_name | String | The vendor's public-facing display name (may differ from name). |
description | String | Vendor description text. |
active | Boolean | Whether the vendor is active. Truthy/falsy values are automatically normalised. |
email_domain | String | The vendor's email domain (e.g. acmecorp.com). |
website | String | The vendor's website URL. |
primary_contact_first_name | String | First name of the vendor's primary contact person. |
primary_contact_last_name | String | Last name of the vendor's primary contact person. |
primary_contact_email | String | Email address of the vendor's primary contact person. |
Example Request
Considerations
- The same general considerations as People ingest apply: requests are processed asynchronously, a 200 Accepted means queued (not yet processed), and event ordering is not guaranteed.
- Existing vendors are matched by resource_id. If no match is found, a new vendor is created.
- The resource_id field accepts both formatted identifiers (e.g. acme/vendor/123 as used in the Updates API) and plain integer record IDs.