Calendar Events
The calendar_event table contains data about events (calendar events) in the organization.
This table can be used to determine which events exist and their properties such as name and event date, as well as metadata about the event such as when it was created.
Columns
| Column Name | Description | Type | Nullable |
|---|---|---|---|
| id | The numerical identifier of the object. | INT8 | No |
| name | The name of the event as it appears on the user interface. | VARCHAR | Yes |
| campaign_id | The numerical identifier of the campaign this event is in. Relates to the id column in the campaigns table. |
INT8 | No |
| start_date | The UTC timestamp when this event starts. | TIMESTAMP | Yes |
| end_date | The UTC timestamp when this event ends. | TIMESTAMP | Yes |
| timezone | The timezone of the event, in TZ Identifier format. | VARCHAR | Yes |
| location_type | The type of location for the event. 0 is in person, 1 is virtual. |
INT4 | Yes |
| location_note | The instructions for a virtual event, as displayed in the user interface. | VARCHAR | Yes |
| action_canvassing_type | The type of task that will be used for automatically created tasks for this event, as determined by campaign settings. NULL for standard, 0 for phone banks, 1 for text banks, and 2 for home visits. |
INT4 | Yes |
| created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
| updated_at | The UTC timestamp when this object was updated. | TIMESTAMP | No |
| entity_type_id | The numerical identifier of the entity type that assigned to this event. Relates to the id column in the entity_types table. |
INT8 | No |
| created_by_id | The numerical identifier of the user that created this event. Relates to the id column in the users table. |
INT4 | No |
| updated_by_id | The numerical identifier of the user that last updated this event. Relates to the id column in the users table. |
INT4 | No |
| calendar_event_type_id | This column is unused and will always be 1. |
INT8 | Yes |