Company entitlements changed

{ "object": "event", "id": "evt_0346sFPEvSkJvY8vt14NNw", "type": "<string>", "data": { "object": { "object": "company", "id": "cmp_0346sFPEvSkJvY8vt14NNw", "account_id": "acct_0346sFPEvSkJvY8vt14NNw", "livemode": true, "name": "<string>", "state": "DE", "entity_type": "llc", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "external_id": "<string>", "ending": "<string>", "industry": "<string>", "industry_description": "<string>", "custom_industry": "<string>", "timezone": "<string>", "pre_existing": true, "ein": "<string>", "verified_at": "2023-11-07T05:31:56Z", "dissolved_at": "2023-11-07T05:31:56Z", "incorporated_at": "2023-11-07T05:31:56Z", "ein_assigned_at": "2023-11-07T05:31:56Z", "incorporation_date": "<string>", "foreign_qualifications": [ { "state": "DE", "line1": "<string>", "city": "<string>", "postal_code": "<string>", "line2": "<string>" } ], "entitlements": { "federal_tax_filing": 1, "state_tax_filing": 0 }, "shareholders": [ { "object": "shareholder", "id": "<string>", "relationship": { "custom_title": "<string>", "percent_ownership": 99, "representative": true, "director": true }, "document": {}, "first_name": "<string>", "last_name": "<string>", "name": "<string>", "representative_name": "<string>", "email": "<string>", "phone": "<string>", "phone_country": "<string>" } ], "officers": [ { "object": "officer", "id": "off_0346sFPEvSkJvY8vt14NNw", "roles": [], "shareholder": "<string>", "first_name": "<string>", "last_name": "<string>", "email": "<string>", "title": "<string>" } ], "officers_settled": true, "metadata": {} } }, "livemode": true, "timestamp": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z", "company_id": "<string>" }

Authorizations

Authorization

string

header

required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Body

application/json

object

enum<string>

required

Entity name. Identifies this object when it arrives without its URL.

Available options:

event

string

required

Identifier of the event.

Pattern: ^evt_[0-9A-Za-z]{22}$

Example:

"evt_0346sFPEvSkJvY8vt14NNw"

type

string

required

What happened, e.g. company.created, company.status.changed, company.verified. Branch on this. New types may be added over time, so treat an unrecognized one as informational rather than an error.

data

object

required

The event's payload: the resource the event is about, embedded as of when the event occurred. This is a point-in-time snapshot, not a live read - a delivery that arrives late still carries the state that triggered it.

Show child attributes

livemode

boolean

required

False for an event recorded in a test-key stream.

timestamp

string<date-time>

required

When the fact the event describes occurred, ISO 8601 - the Standard Webhooks envelope field. Usually identical to created_at, because events are recorded in the same transaction as their change. Where a truer stamp exists it is used instead and can PRECEDE created_at: company.incorporated carries the incorporation stamp itself, which can predate when the event was recorded, and calendar.reminder carries the remind moment. Filter and page by created_at (the record clock). Read timestamp for when it happened. The time of a delivery ATTEMPT is a third thing and never appears in the payload - it is the webhook-timestamp header, fresh on every retry.

created_at

string<date-time>

required

When the event was recorded.

company_id

string

The company the event is about, when it is about one.

Pattern: ^cmp_[0-9A-Za-z]{22}$

Response

200

Acknowledged. Any 2xx marks the delivery received and stops retries.

Identity

Accounts

Companies

Officers & directors

Products and pricing

Service orders

Tax filings

Fixed assets

Requirements

Verification and signing

Files

File links

Calendar

Status tracking

Events

Hosted links

Sandbox

Webhook events

Company entitlements changed

Authorizations

Body

Response