Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier of the event |
| eventType | string | The type of event. |
| generatedDate | object | The date time in UTC the event was generated in Codat. |
| payload | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/CompanyWebhook",
"title": "Company webhook",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "ba29118f-5406-4e59-b05c-ba307ca38d01",
"description": "Unique identifier of the event"
},
"eventType": {
"type": "string",
"description": "The type of event.",
"examples": [
"company.created",
"company.deleted"
]
},
"generatedDate": {
"$ref": "#/components/schemas/DateTime",
"description": "The date time in UTC the event was generated in Codat."
},
"payload": {
"$ref": "#/components/schemas/Company/definitions/companyDetails"
}
}
}