Skip to content
SynupAPI
Get an API key
EVENTlisting.submission

Directory listing synced (success/incomplete)

Event name: listing.submission

Sent when Synup finishes attempting to sync a business listing to a directory (Google, Facebook, etc.), triggered by profile updates or new directory submissions. Delivered to your Webhooks URL (Listings webhook). One delivery per status change — a move from incomplete to success sends two separate calls. Note the compact envelope: there is no top-level timestamp or account_id, and the location is identified by the Base64 id inside data.

Every delivery is signed. Verify X-Synup-Signature before processing — see Synup Webhooks.

Payload

NameTypeRequiredDescription
eventstringoptionalAlways "listing.submission".
statusstringoptional"success" (listing is live on the directory) or "incomplete" (could not be completed).
live_linkstringoptionalPublic URL of the live listing. Present only when status is "success".
error_messagestringoptionalWhy the submission could not be completed. Present only when status is "incomplete".
dataobjectoptional
data.business_idintegeroptionalSynup's internal numeric ID for the location.
data.v4_business_idstringoptionalBase64-encoded location identifier for the v4 API. Same value as data.location_id.
data.location_idstringoptionalBase64-encoded location identifier. Same value as data.v4_business_id.
data.siteobjectoptionalThe directory the listing was synced to.
data.site.idintegeroptionalSynup's internal ID for the directory.
data.site.namestringoptionalDirectory name (e.g. "Google", "Yelp", "Infobel").
data.site.urlstringoptionalRoot domain of the directory (e.g. "infobel.com").
Example delivery
{
  "event": "listing.submission",
  "status": "success",
  "live_link": "https://www.infobel.com/en/usa/example_business/portland/USOR000000-5550001000/businessdetails.aspx",
  "data": {
    "business_id": 1000001,
    "v4_business_id": "TG9jYXRpb246MTAwMDAwMQ==",
    "location_id": "TG9jYXRpb246MTAwMDAwMQ==",
    "site": {
      "id": 314,
      "name": "Infobel",
      "url": "infobel.com"
    }
  }
}