-
Notifications
You must be signed in to change notification settings - Fork 32
/
src_hubspot.yml
1348 lines (1268 loc) · 69.3 KB
/
src_hubspot.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
version: 2
sources:
- name: hubspot
schema: "{{ var('hubspot_schema', 'hubspot') }}"
database: "{% if target.type != 'spark'%}{{ var('hubspot_database', target.database) }}{% endif %}"
loader: Fivetran
loaded_at_field: _fivetran_synced
tables:
- name: calendar_event
identifier: "{{ var('hubspot_calendar_event_identifier', 'calendar_event')}}"
description: Each record represents a calendar event.
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: avatar_url
description: URL of image associated with social media event.
- name: campaign_guid
description: Value of campaign GUID associated with Task.
- name: category
description: |
Type of event. If the event type is PUBLISHING_TASK, it is one of BLOG_POST, EMAIL, LANDING_PAGE, CUSTOM.
If event type is SOCIAL, it is one of twitter, facebook, linkedin, googlepluspages.
If event type is CONTENT, it is one of email, recurring-email, blog-post, landing-page, legacy-page, site-page.
- name: category_id
description: |
For event type of PUBLISHING_TASK, a numeric value corresponding to the type of task; one of 3 (BLOG_POST), 2 (EMAIL), 1 (LANDING_PAGE), 0 (CUSTOM).
For event type of SOCIAL, this is 0.
If event type is CONTENT, it is one of 2 (email, recurring-email), 3 (blog-post), 1 (landing-page), 5 (legacy-page), 4 (site-page).
- name: content_group_id
description: |
The ID of the content group (aka blog) that the associated Blog Post belongs to, if any.
Otherwise null. Only populated for single task GETs and for Blog Post Tasks.
- name: content_id
description: ID value of the COS content object associated with the event, null for social or if nothing associated.
- name: created_by
description: HubSpot ID of the user that the event was created by.
- name: description
description: Description of Event.
- name: event_date
description: If task, When the task is set to be due, otherwise when the event is/ was scheduled for; in milliseconds since the epoch.
- name: event_type
description: Type of calendar event; for tasks this is PUBLISHING_TASK, for COS Items, this is CONTENT, for social media events, this is SOCIAL
- name: id
description: The unique ID of the task.
- name: is_recurring
description: Whether the event is recurring.
- name: name
description: Name of Event.
- name: owner_id
description: TASK - HubSpot ID of the user that the task is assigned to.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: preview_key
description: Preview key of content object; used for showing previews of unpublished items.
- name: social_display_name
description: Social media full name associate with event.
- name: social_username
description: Social media user name associated with event.
- name: state
description: For type publishing task, value of TODO or DONE, for others, a value of SCHEDULED, PUBLISHED, PUBLISHED_OR_SCHEDULED.
- name: topic_ids
description: The list of IDs of topics associated with the associated Blog Post, if any. Otherwise null. Only populated for single task GETs and for Blog Post Tasks.
- name: url
description: Public URL of content item.
- name: company
identifier: "{{ var('hubspot_company_identifier', 'company')}}"
description: Each record represents a company in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_company_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: id
description: The ID of the company.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: is_deleted
description: '{{ doc("is_deleted") }}'
- name: property_name
description: The name of the company.
- name: property_description
description: A short statement about the company's mission and goals.
- name: property_createdate
description: The date the company was added to your account.
- name: property_industry
description: The type of business the company performs.
- name: property_address
description: The street address of the company.
- name: property_address_2
description: Additional address information for the company.
- name: property_city
description: The city where the company is located.
- name: property_state
description: The state where the company is located.
- name: property_country
description: The country where the company is located.
- name: property_annualrevenue
description: The actual or estimated annual revenue of the company.
- name: company_property_history
identifier: "{{ var('hubspot_company_property_history_identifier', 'company_property_history')}}"
description: Each record represents a change to company record in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_company_enabled', true) and var('hubspot_company_property_history_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: company_id
description: The ID of the related company record.
- name: name
description: '{{ doc("history_name") }}'
- name: source
description: '{{ doc("history_source") }}'
- name: source_id
description: '{{ doc("history_source_id") }}'
- name: timestamp
description: '{{ doc("history_timestamp") }}'
- name: value
description: '{{ doc("history_value") }}'
- name: contact_merge_audit
identifier: "{{ var('hubspot_contact_merge_audit_identifier', 'contact_merge_audit')}}"
description: >
DEPRECATED FOR NON-BIGQUERY USERS (will be deprecated on BigQuery as well). Each record contains a contact merge event and the contacts effected by the merge.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_merge_audit_enabled', false) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: canonical_vid
description: The contact ID of the contact which the vid_to_merge contact was merged into.
- name: contact_id
description: The ID of the contact.
- name: entity_id
description: The ID of the related entity.
- name: first_name
description: The contact's first name.
- name: last_name
description: The contact's last name.
- name: num_properties_moved
description: The number of properties which were removed from the merged contact.
- name: timestamp
description: Timestamp of when the contacts were merged.
- name: user_id
description: The ID of the user.
- name: vid_to_merge
description: The ID of the contact which was merged.
- name: contact
identifier: "{{ var('hubspot_contact_identifier', 'contact')}}"
freshness:
warn_after: {count: 84, period: hour}
error_after: {count: 168, period: hour}
description: Each record represents a contact in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_enabled', true) }}"
columns:
- name: _fivetran_deleted
description: '{{ doc("_fivetran_deleted") }}'
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: id
description: The ID of the contact.
- name: property_email_1
description: The email address of the contact.
- name: property_company
description: The name of the contact's company.
- name: property_firstname
description: The contact's first name.
- name: property_lastname
description: The contact's last name.
- name: property_email
description: The contact's email.
- name: property_createdate
description: The date that the contact was created in your HubSpot account.
- name: property_jobtitle
description: The contact's job title.
- name: property_annualrevenue
description: The contact's annual company revenue.
- name: property_hs_calculated_merged_vids
description: >
List of mappings representing contact IDs that have been merged into the contact at hand.
Format: <merged_contact_id>:<merged_at_in_epoch_time>;<second_merged_contact_id>:<merged_at_in_epoch_time>
This field has replaced the `CONTACT_MERGE_AUDIT` table, which was deprecated by the Hubspot v3 CRM API.
- name: contact_form_submission
identifier: "{{ var('hubspot_contact_form_submission_identifier', 'contact_form_submission')}}"
description: Table containing contact form submission information
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: contact_id
description: The ID of the related contact.
- name: conversion_id
description: A Unique ID for the specific form conversion.
- name: form_id
description: The GUID of the form that the submission belongs to.
- name: page_url
description: The URL that the form was submitted on, if applicable.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: timestamp
description: A Unix timestamp in milliseconds of the time the submission occurred.
- name: title
description: The title of the page that the form was submitted on. This will default to the name of the form if no title is provided.
- name: contact_list
identifier: "{{ var('hubspot_contact_list_identifier', 'contact_list')}}"
description: Each record represents a contact list in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_list_enabled', true) }}"
columns:
- name: _fivetran_deleted
description: '{{ doc("_fivetran_deleted") }}'
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: created_at
description: A timestamp of the time the list was created.
- name: deleteable
description: If this is false, this is a system list and cannot be deleted.
- name: dynamic
description: Whether the contact list is dynamic.
- name: id
description: The ID of the contact list.
- name: metadata_error
description: Any errors that happened the last time the list was processed.
- name: metadata_last_processing_state_change_at
description: A timestamp of the last time that the processing state changed.
- name: metadata_last_size_change_at
description: A timestamp of the last time that the size of the list changed.
- name: metadata_processing
description: |
One of DONE, REFRESHING, INITIALIZING, or PROCESSING.
DONE indicates the list has finished processing, any other value indicates that list membership is being evaluated.
- name: metadata_size
description: The approximate number of contacts in the list.
- name: name
description: The name of the contact list.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: updated_at
description: A timestamp of the time that the list was last modified.
- name: contact_list_member
identifier: "{{ var('hubspot_contact_list_member_identifier', 'contact_list_member')}}"
description: Each record represents a 'link' between a contact and a contact list.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_list_member_enabled', true) }}"
columns:
- name: _fivetran_deleted
description: '{{ doc("_fivetran_deleted") }}'
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: added_at
description: The timestamp a contact was added to a list.
- name: contact_id
description: The ID of the related contact.
- name: contact_list_id
description: The ID of the related contact list.
- name: contact_property_history
identifier: "{{ var('hubspot_contact_property_history_identifier', 'contact_property_history')}}"
freshness:
warn_after: {count: 84, period: hour}
error_after: {count: 168, period: hour}
description: Each record represents a change to contact record in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_contact_property_enabled', true) and var('hubspot_contact_property_history_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: contact_id
description: The ID of the related contact record.
- name: name
description: '{{ doc("history_name") }}'
- name: source
description: '{{ doc("history_source") }}'
- name: source_id
description: '{{ doc("history_source_id") }}'
- name: timestamp
description: '{{ doc("history_timestamp") }}'
- name: value
description: '{{ doc("history_value") }}'
- name: deal
identifier: "{{ var('hubspot_deal_identifier', 'deal')}}"
description: Each record represents a deal in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) }}"
columns:
- name: deal_id
description: The ID of the deal.
- name: is_deleted
description: Whether the record was deleted.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: deal_pipeline_id
description: The ID of the deal's pipeline.
- name: deal_pipeline_stage_id
description: The ID of the deal's pipeline stage.
- name: owner_id
description: The ID of the deal's owner.
- name: property_dealname
description: The name you have given this deal.
- name: property_description
description: A brief description of the deal.
- name: property_amount
description: The total value of the deal in the deal's currency.
- name: property_closedate
description: The day the deal is expected to close, or was closed.
- name: property_createdate
description: The date the deal was created. This property is set automatically by HubSpot.
- name: deal_stage
identifier: "{{ var('hubspot_deal_stage_identifier', 'deal_stage')}}"
description: Each record represents a deal stage.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) }}"
columns:
- name: _fivetran_active
description: Boolean indicating whether the deal stage is active.
- name: _fivetran_end
description: The Fivetran calculated exist time of the deal stage.
- name: _fivetran_start
description: The date the deal stage was entered.
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: date_entered
description: The timestamp the deal stage was entered.
- name: deal_id
description: Reference to the deal.
- name: source
description: The relevant source of the deal stage.
- name: source_id
description: Reference to the source.
- name: value
description: The value of the deal stage. Typically the name of the stage.
- name: deal_company
identifier: "{{ var('hubspot_deal_company_identifier', 'deal_company')}}"
description: Each record represents a 'link' between a deal and company.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) and var('hubspot_deal_company_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: company_id
description: The ID of the company.
- name: deal_id
description: The ID of the deal.
- name: type_id
description: The ID of the type.
- name: category
description: The association category. Either HUBSPOT_DEFINED (default label) or USER_DEFINED (custom label).
- name: deal_contact
identifier: "{{ var('hubspot_deal_contact_identifier', 'deal_contact')}}"
description: Each record represents a 'link' between a deal and a contact.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) and var('hubspot_deal_contact_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: contact_id
description: The ID of the contact.
- name: deal_id
description: The ID of the deal.
- name: type_id
description: The ID of the type.
- name: category
description: The association category. Either HUBSPOT_DEFINED (default label) or USER_DEFINED (custom label).
- name: deal_pipeline
identifier: "{{ var('hubspot_deal_pipeline_identifier', 'deal_pipeline')}}"
description: Each record represents a pipeline in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) }}"
columns:
- name: _fivetran_deleted
description: '{{ doc("_fivetran_deleted") }}'
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: active
description: Whether the stage is currently in use.
- name: display_order
description: Used to determine the order in which the pipelines appear when viewed in HubSpot.
- name: label
description: The human-readable label for the pipeline. The label is used when showing the pipeline in HubSpot.
- name: pipeline_id
description: The ID of the pipeline.
- name: created_at
description: A timestamp representing when the record was created.
- name: updated_at
description: A timestamp representing when the record was updated.
- name: deal_pipeline_stage
identifier: "{{ var('hubspot_deal_pipeline_stage_identifier', 'deal_pipeline_stage')}}"
description: Each record represents a pipeline stage in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) }}"
columns:
- name: _fivetran_deleted
description: '{{ doc("_fivetran_deleted") }}'
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: active
description: Whether the pipeline stage is currently in use.
- name: closed_won
description: Whether the stage represents a Closed Won deal.
- name: display_order
description: Used to determine the order in which the stages appear when viewed in HubSpot.
- name: label
description: The human-readable label for the stage. The label is used when showing the stage in HubSpot.
- name: pipeline_id
description: The ID of the related pipeline.
- name: probability
description: The probability that the deal will close. Used for the deal forecast.
- name: stage_id
description: The ID of the pipeline stage.
- name: created_at
description: A timestamp representing when the record was created.
- name: updated_at
description: A timestamp representing when the record was updated.
- name: deal_property_history
identifier: "{{ var('hubspot_deal_property_history_identifier', 'deal_property_history')}}"
description: Each record represents a change to deal record in Hubspot.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_deal_enabled', true) and var('hubspot_deal_property_history_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: deal_id
description: The ID of the related deal record.
- name: name
description: '{{ doc("history_name") }}'
- name: source
description: '{{ doc("history_source") }}'
- name: source_id
description: '{{ doc("history_source_id") }}'
- name: timestamp
description: '{{ doc("history_timestamp") }}'
- name: value
description: '{{ doc("history_value") }}'
- name: email_campaign
identifier: "{{ var('hubspot_email_campaign_identifier', 'email_campaign')}}"
description: Each record represents an email campaign in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: app_id
description: The app ID.
- name: app_name
description: The app name.
- name: content_id
description: The ID of the content.
- name: id
description: The ID of the email campaign.
- name: name
description: The name of the email campaign.
- name: num_included
description: The number of messages included as part of the email campaign.
- name: num_queued
description: The number of messages queued as part of the email campaign.
- name: sub_type
description: The email campaign sub-type.
- name: subject
description: The subject of the email campaign.
- name: type
description: The email campaign type.
- name: email_event
identifier: "{{ var('hubspot_email_event_identifier', 'email_event')}}"
freshness:
warn_after: {count: 84, period: hour}
error_after: {count: 168, period: hour}
description: Each record represents an email event in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: app_id
description: The ID of the app that sent the email.
- name: caused_by_created
description: The timestamp of the event that caused this event.
- name: caused_by_id
description: The event ID which uniquely identifies the event which directly caused this event. If not applicable, this property is omitted.
- name: created
description: The created timestamp of the event.
- name: email_campaign_id
description: The ID of the related email campaign.
- name: filtered_event
description: A boolean representing whether the event has been filtered out of reporting based on customer reports settings or not.
- name: id
description: The ID of the event.
- name: obsoleted_by_created
description: The timestamp of the event that made the current event obsolete.
- name: obsoleted_by_id
description: The event ID which uniquely identifies the follow-on event which makes this current event obsolete. If not applicable, this property is omitted.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: recipient
description: The email address of the contact related to the event.
- name: sent_by_created
description: The timestamp of the SENT event related to this event.
- name: sent_by_id
description: The event ID which uniquely identifies the email message's SENT event. If not applicable, this property is omitted.
- name: type
description: The type of event.
- name: email_event_bounce
identifier: "{{ var('hubspot_email_event_bounce_identifier', 'email_event_bounce')}}"
description: Each record represents a BOUNCE email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_bounce_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: category
description: |
The best-guess of the type of bounce encountered.
If an appropriate category couldn't be determined, this property is omitted. See below for the possible values.
Note that this is a derived value, and may be modified at any time to improve the accuracy of classification.
- name: id
description: The ID of the event.
- name: response
description: The full response from the recipient's email server.
- name: status
description: The status code returned from the recipient's email server.
- name: email_event_click
identifier: "{{ var('hubspot_email_event_click_identifier', 'email_event_click')}}"
description: Each record represents a CLICK email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_click_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: browser
description: '{{ doc("email_event_browser") }}'
- name: id
description: The ID of the event.
- name: ip_address
description: '{{ doc("email_event_ip_address") }}'
- name: location
description: '{{ doc("email_event_location") }}'
- name: referer
description: The URL of the webpage that linked to the URL clicked. Whether this is provided, and what its value is, is determined by the recipient's email client.
- name: url
description: The URL within the message that the recipient clicked.
- name: user_agent
description: '{{ doc("email_event_user_agent") }}'
- name: email_event_deferred
identifier: "{{ var('hubspot_email_event_deferred_identifier', 'email_event_deferred')}}"
description: Each record represents a DEFERRED email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_deferred_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: attempt
description: The delivery attempt number.
- name: id
description: The ID of the event.
- name: response
description: The full response from the recipient's email server.
- name: email_event_delivered
identifier: "{{ var('hubspot_email_event_delivered_identifier', 'email_event_delivered')}}"
description: Each record represents a DELIVERED email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_delivered_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: id
description: The ID of the event.
- name: response
description: The full response from the recipient's email server.
- name: smtp_id
description: An ID attached to the message by HubSpot.
- name: email_event_dropped
identifier: "{{ var('hubspot_email_event_dropped_identifier', 'email_event_dropped')}}"
description: Each record represents a DROPPED email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_dropped_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: bcc
description: The 'bcc' field of the email message.
- name: cc
description: The 'cc' field of the email message.
- name: drop_message
description: The raw message describing why the email message was dropped. This will usually provide additional details beyond 'dropReason'.
- name: drop_reason
description: The reason why the email message was dropped. See below for the possible values.
- name: from
description: The 'from' field of the email message.
- name: id
description: The ID of the event.
- name: reply_to
description: The 'reply-to' field of the email message.
- name: subject
description: The subject line of the email message.
- name: email_event_forward
identifier: "{{ var('hubspot_email_event_forward_identifier', 'email_event_forward')}}"
description: Each record represents a FORWARD email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_forward_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: browser
description: '{{ doc("email_event_browser") }}'
- name: id
description: The ID of the event.
- name: ip_address
description: '{{ doc("email_event_ip_address") }}'
- name: location
description: '{{ doc("email_event_location") }}'
- name: user_agent
description: '{{ doc("email_event_user_agent") }}'
- name: email_event_open
identifier: "{{ var('hubspot_email_event_open_identifier', 'email_event_open')}}"
description: Each record represents a OPEN email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_open_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: browser
description: '{{ doc("email_event_browser") }}'
- name: duration
description: If provided and nonzero, the approximate number of milliseconds the user had opened the email.
- name: id
description: The ID of the event.
- name: ip_address
description: '{{ doc("email_event_ip_address") }}'
- name: location
description: '{{ doc("email_event_location") }}'
- name: user_agent
description: '{{ doc("email_event_user_agent") }}'
- name: email_event_print
identifier: "{{ var('hubspot_email_event_print_identifier', 'email_event_print')}}"
description: Each record represents a PRINT email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_print_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: browser
description: '{{ doc("email_event_browser") }}'
- name: id
description: The ID of the event.
- name: ip_address
description: '{{ doc("email_event_ip_address") }}'
- name: location
description: '{{ doc("email_event_location") }}'
- name: user_agent
description: '{{ doc("email_event_user_agent") }}'
- name: email_event_sent
identifier: "{{ var('hubspot_email_event_sent_identifier', 'email_event_sent')}}"
description: Each record represents a SENT email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_sent_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: bcc
description: The 'cc' field of the email message.
- name: cc
description: The 'bcc' field of the email message.
- name: from
description: The 'from' field of the email message.
- name: id
description: The ID of the event.
- name: reply_to
description: The 'reply-to' field of the email message.
- name: subject
description: The subject line of the email message.
- name: email_event_spam_report
identifier: "{{ var('hubspot_email_event_spam_report_identifier', 'email_event_spam_report')}}"
description: Each record represents a SPAM_REPORT email event.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_spam_report_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: id
description: The ID of the event.
- name: ip_address
description: '{{ doc("email_event_ip_address") }}'
- name: user_agent
description: '{{ doc("email_event_user_agent") }}'
- name: email_event_status_change
identifier: "{{ var('hubspot_email_event_status_change_identifier', 'email_event_status_change')}}"
description: Each record represents a STATUS_CHANGE email event in Hubspot.
config:
enabled: "{{ var('hubspot_marketing_enabled', true) and var('hubspot_email_event_enabled', true) and var('hubspot_email_event_status_change_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: bounced
description: |
A HubSpot employee explicitly initiated the status change to block messages to the recipient.
(Note this usage has been deprecated in favor of dropping messages with a 'dropReason' of BLOCKED_ADDRESS.)
- name: id
description: The ID of the event.
- name: portal_subscription_status
description: |
The recipient's portal subscription status.
Note that if this is 'UNSUBSCRIBED', the property 'subscriptions' is not necessarily an empty array, nor are all
subscriptions contained in it necessarily going to have their statuses set to 'UNSUBSCRIBED'.)
- name: requested_by
description: The email address of the person requesting the change on behalf of the recipient. If not applicable, this property is omitted.
- name: source
description: The source of the subscription change.
- name: subscriptions
description: |
An array of JSON objects representing the status of subscriptions for the recipient.
Each JSON subscription object is comprised of the properties: 'id', 'status'.
- name: email_subscription
identifier: "{{ var('hubspot_email_subscription_identifier', 'email_subscription')}}"
description: Each record represents an email subscription in Hubspot.
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: active
description: Whether the subscription is active.
- name: description
description: The description of the subscription.
- name: id
description: The ID of the email subscription.
- name: name
description: The name of the email subscription.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: email_subscription_change
identifier: "{{ var('hubspot_email_subscription_change_identifier', 'email_subscription_change')}}"
description: Each record represents a change to an email subscription in Hubspot.
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: caused_by_event_id
description: The ID of the event that caused the subscription change.
- name: change
description: The change which occurred. This enumeration is specific to the 'changeType'; see below for the possible values.
- name: change_type
description: The type of change which occurred.
- name: email_subscription_id
description: The ID of the related email subscription.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: recipient
description: The email address of the related contact.
- name: source
description: The source of the subscription change.
- name: timestamp
description: The timestamp when this change occurred. If 'causedByEvent' is present, this will be absent.
- name: engagement
identifier: "{{ var('hubspot_engagement_identifier', 'engagement')}}"
description: Each record represents an engagement
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: active
description: >
Whether the engagement is currently being shown in the UI.
PLEASE NOTE: This field will not be populated for connectors utilizing the HubSpot v3 API version. This field will be deprecated in a future release.
- name: created_at
description: >
A timestamp representing when the engagement was created.
PLEASE NOTE: This field will not be populated for connectors utilizing the HubSpot v3 API version. This field will be deprecated in a future release.
- name: id
description: The ID of the engagement.
- name: owner_id
description: >
The ID of the engagement's owner.
PLEASE NOTE: This field will not be populated for connectors utilizing the HubSpot v3 API version. This field will be deprecated in a future release.
- name: portal_id
description: '{{ doc("portal_id") }}'
- name: timestamp
description: >
A timestamp in representing the time that the engagement should appear in the timeline.
PLEASE NOTE: This field will not be populated for connectors utilizing the HubSpot v3 API version. This field will be deprecated in a future release.
- name: type
description: One of NOTE, EMAIL, TASK, MEETING, or CALL, the type of the engagement.
- name: engagement_call
identifier: "{{ var('hubspot_engagement_call_identifier', 'engagement_call')}}"
description: Each record represents a CALL engagement event.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_call_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: engagement_id
description: The ID of the engagement.
- name: _fivetran_deleted
description: Boolean to mark rows that were deleted in the source database.
- name: property_hs_createdate
description: >
This field marks the call's time of creation and determines where the call sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: timestamp
description: >
This field marks the call's time of occurrence and determines where the call sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_owner_id
description: >
The ID of the owner associated with the call. This field determines the user listed as the call creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_team_id
description: >
The ID of the team associated with the call. This field determines the team listed as the call creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version.
- name: engagement_company
identifier: "{{ var('hubspot_engagement_company_identifier', 'engagement_company')}}"
description: Each record represents a 'link' between a company and an engagement.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_company_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: company_id
description: The ID of the related company.
- name: engagement_id
description: The ID of the related engagement.
- name: category
description: The association category. Either HUBSPOT_DEFINED (default label) or USER_DEFINED (custom label).
- name: engagement_contact
identifier: "{{ var('hubspot_engagement_contact_identifier', 'engagement_contact')}}"
description: Each record represents a 'link' between a contact and an engagement.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_contact_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: contact_id
description: The ID of the related contact.
- name: engagement_id
description: The ID of the related engagement.
- name: category
description: The association category. Either HUBSPOT_DEFINED (default label) or USER_DEFINED (custom label).
- name: engagement_deal
identifier: "{{ var('hubspot_engagement_deal_identifier', 'engagement_deal')}}"
description: Each record represents a 'link' between a deal and an engagement.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_deal_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: deal_id
description: The ID of the related contact.
- name: engagement_id
description: The ID of the related engagement.
- name: category
description: The association category. Either HUBSPOT_DEFINED (default label) or USER_DEFINED (custom label).
- name: engagement_email
identifier: "{{ var('hubspot_engagement_email_identifier', 'engagement_email')}}"
description: Each record represents an EMAIL engagement event.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_email_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: engagement_id
description: The ID of the engagement.
- name: property_hs_createdate
description: >
This field marks the email's time of creation and determines where the email sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: timestamp
description: >
This field marks the email's time of occurrence and determines where the email sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_owner_id
description: >
The ID of the owner associated with the email. This field determines the user listed as the email creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_team_id
description: >
The ID of the team associated with the email. This field determines the team listed as the email creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version.
- name: engagement_email_cc
identifier: "{{ var('hubspot_engagement_email_cc_identifier', 'engagement_email_cc')}}"
description: Each record represents a CC'd email address as part of an EMAIL engagement.
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: email
description: The email address of the recipient.
- name: engagement_id
description: The ID of the related engagement.
- name: first_name
description: The first name of the recipient.
- name: last_name
description: The last name of the recipient.
- name: engagement_email_to
identifier: "{{ var('hubspot_engagement_email_to_identifier', 'engagement_email_to')}}"
description: Each record represents a TO email address as part of an EMAIL engagement.
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: email
description: The email address of the recipient.
- name: engagement_id
description: The ID of the related engagement.
- name: first_name
description: The first name of the recipient.
- name: last_name
description: The last name of the recipient.
- name: engagement_meeting
identifier: "{{ var('hubspot_engagement_meeting_identifier', 'engagement_meeting')}}"
description: Each record represents a MEETING engagement event.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_meeting_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: engagement_id
description: The ID of the engagement.
- name: property_hs_createdate
description: >
This field marks the meeting's time of creation and determines where the meeting sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: timestamp
description: >
This field marks the meeting's time of occurrence and determines where the meeting sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_owner_id
description: >
The ID of the owner associated with the meeting. This field determines the user listed as the meeting creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: property_hubspot_team_id
description: >
The ID of the team associated with the meeting. This field determines the team listed as the meeting creator on the record timeline.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version.
- name: engagement_note
identifier: "{{ var('hubspot_engagement_note_identifier', 'engagement_note')}}"
description: Each record represents a NOTE engagement event.
config:
enabled: "{{ var('hubspot_sales_enabled', true) and var('hubspot_engagement_enabled', true) and var('hubspot_engagement_note_enabled', true) }}"
columns:
- name: _fivetran_synced
description: '{{ doc("_fivetran_synced") }}'
- name: body
description: The body of the note. The body has a limit of 65536 characters.
- name: engagement_id
description: The ID of the engagement.
- name: property_hs_createdate
description: >
This field marks the note's time of creation and determines where the note sits on the record timeline. You can use either a Unix timestamp in milliseconds or UTC format.
PLEASE NOTE: This field will only be populated for connectors utilizing the HubSpot v3 API version. For the pre HubSpot v3 versions, this value may be found within the parent `engagement` table.
- name: timestamp