Sign in

Called when a company is created in Codat.

postWebhookcompany.created

Payload

idstring uuid

Unique identifier of the event

eventTypestring

The type of event.

generatedDatestring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

payloadCompanyDetails — unresolved $ref

Example payload

{
  "id": "ba29118f-5406-4e59-b05c-ba307ca38d01",
  "type": "company.created",
  "generatedDate": "2024-08-08T17:10:34.015Z",
  "payload": {
    "id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
    "name": "Bank of Dave",
    "description": "Requested a loan for refurb.",
    "redirect": "https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2",
    "lastSync": "2022-01-01T12:00:00.000Z",
    "created": "2022-01-01T12:00:00.000Z",
    "tags": {
      "customerRegion": "us",
      "uid": "335a086e-8563-4b03-94e3-39544225ecb6"
    }
  }
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes