Event data model
An event represents an event, activity, or engagement and is always associated with a deal, contact, or company
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this event object |
created_at | string (date-time) | No | The date that this event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this event object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
type | enum | No | The type of event Values: NOTE, EMAIL, TASK, MEETING, CALL, MARKETING_EMAIL, FORM, PAGE_VIEW |
note | object | No | The note object, when type = note |
note.description | string | No | The event note's description |
note.title | string | No | |
meeting | object | No | The meeting object, when type = meeting |
meeting.start_at | string (date-time) | No | The event meeting's start datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
meeting.end_at | string (date-time) | No | The event meeting's end datetime (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
meeting.title | string | No | The event meeting's topicsubject |
meeting.description | string | No | The event meeting's agendadescription |
email | object | No | The email object, when type = email |
email.from | string | No | The event email's from name & email address (name <test@test.com>) |
email.to | string[] | No | The event email's "to" name & email (name <test@test.com>) |
email.cc | string[] | No | The event email's cc name & email (name <test@test.com>) |
email.subject | string | No | The event email's subject |
email.body | string | No | The event email's body |
email.attachment_file_ids | string[] | No | |
call | object | No | The call object, when type = call |
call.duration | number | No | The event call's duration in minutes |
call.description | string | No | The event call's descriptionnotes |
call.start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
task | object | No | The task object, when type = task |
task.name | string | No | The event task's nametitle/subject |
task.status | enum | No | The event task's status Values: COMPLETED, NOT_STARTED, WORK_IN_PROGRESS, DEFERRED |
task.description | string | No | The event task's descriptionnote |
task.due_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
task.priority | enum | No | Values: HIGH, MEDIUM, LOW |
marketing_email | object | No | |
marketing_email.name | string | No | |
marketing_email.from | string | No | The event email's from name & email address (name <test@test.com>) |
marketing_email.to | string[] | No | The event email's "to" name & email (name <test@test.com>) |
marketing_email.cc | string[] | No | The event email's cc name & email (name <test@test.com>) |
marketing_email.subject | string | No | The event email's subject |
marketing_email.body | string | No | The event email's body |
marketing_email.attachment_file_ids | string[] | No | |
form | object | No | |
form.name | string | No | |
form.archived_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
form.fields | CrmEventFormField[] | No | |
form.fields[].name | string | No | |
form.fields[].type | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, MULTIPLE_CHOICE, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, EMAIL, PHONE, YES_NO, CURRENCY, URL |
form.fields[].options | CrmEventFormOption[] | No | |
form.fields[].options[].label | string | No | |
form.fields[].options[].value | string | No | |
form.fields[].required | boolean | No | |
form.redirect_url | string | No | |
page_view | object | No | |
page_view.count | number | No | |
page_view.average | number | No | |
page_view.url | string | No | |
deal_ids | string[] | No | An array of deal IDs associated with this event |
company_ids | string[] | No | An array of company IDs associated with this event |
contact_ids | string[] | No | An array of contact IDs associated with this event |
lead_ids | string[] | No | (reference to CrmLead) |
user_id | string | No | (reference to HrisEmployee) |
Are we missing anything? Let us know