Webhooks

Locations > Location > Updates

Subscription_type: locations/location/update

postWebhookWebhooks > Locations > Location > Updates

Payload

idstring required

Unique identifier of the workplace

company_idstring required

ID of the company this workplace belongs to

namestring required

Human-readable name of the workplace (e.g. "Barcelona Office")

timezonestring

IANA timezone the workplace operates in (e.g. "Europe/Madrid")

countrystring

ISO country code of the workplace — the jurisdiction it sits in, often used for country-specific policy thresholds

statestring

State or province the workplace is located in

citystring

City the workplace is located in

address_line_1string

First line of the workplace street address

address_line_2string

Second line of the workplace street address (suite, floor, …)

postal_codestring

Postal/ZIP code of the workplace address

phone_numberstring

Contact phone number for the workplace

mainboolean required

Whether this is the company's main (HQ) workplace

latitudenumber

latitude of the location

longitudenumber

longitude of the location

radiusnumber

radius of the location

siretstring

siret of the location (only for France)

Example payload

{
  "id": "1",
  "company_id": "1",
  "name": "Barcelona Office",
  "timezone": "Europe/Madrid",
  "country": "es",
  "state": "Barcelona",
  "city": "Barcelona",
  "address_line_1": "Carrer Mallorca",
  "address_line_2": "61 2A",
  "postal_code": "08005",
  "phone_number": "657483987",
  "latitude": 52.378,
  "longitude": 4.898,
  "radius": 5,
  "siret": "FR00123456789"
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.