SOsoraban
Webhooks

entity_added

An entity was created.

postWebhookentity_added

Payload

idinteger
namestring nullable
entity_typestring nullable
streetstring nullable
citystring nullable
statestring nullable
zipstring nullable
countrystring nullable
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
firm_role_summarystring

A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use GET /entities/{entity_id}/firm_role_assignments if you need the underlying ids.

Example payload

{
  "firm_role_summary": "Partner: Jane Doe, Manager: John Smith"
}

Response

Return any 2xx to acknowledge. Returning 410 Gone deletes the subscription.

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.