Connection data model

Updated:

A connection represents a specific authentication of an integration.

FieldTypeRequiredDescription
idstringNoUnique identifier for this integration object (read-only)
created_atstring (date-time)NoThe date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
updated_atstring (date-time)NoThe last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
workspace_idstringNo(reference to KmsSpace) (read-only)
integration_typestringYesThe integration type
integration_namestringNo
external_xrefstringNocustomer's user ID
permissionsenumYesValues: accounting_account_read, accounting_account_write, accounting_transaction_read, accounting_transaction_write, accounting_journal_read, accounting_journal_write, accounting_invoice_read, accounting_invoice_write, accounting_bill_read, accounting_bill_write, accounting_vendorcredit_read, accounting_vendorcredit_write, accounting_creditmemo_read, accounting_creditmemo_write, accounting_contact_read, accounting_contact_write, accounting_expense_read, accounting_expense_write, accounting_expensereport_read, accounting_expensereport_write, accounting_purchasereceipt_read, accounting_purchasereceipt_write, accounting_taxrate_read, accounting_taxrate_write, accounting_paymentterm_read, accounting_paymentterm_write, accounting_organization_read, accounting_order_read, accounting_order_write, accounting_purchaseorder_read, accounting_purchaseorder_write, accounting_salesorder_read, accounting_salesorder_write, accounting_salesreceipt_read, accounting_salesreceipt_write, accounting_trialbalance_read, accounting_trialbalance_write, accounting_profitloss_read, accounting_profitloss_write, accounting_balancesheet_read, accounting_balancesheet_write, accounting_category_read, accounting_category_write, payment_payment_read, payment_payment_write, accounting_cashflow_read, accounting_cashflow_write, accounting_quote_read, accounting_quote_write, accounting_agedreceivable_read, accounting_agedpayable_read, accounting_project_read, accounting_project_write, accounting_bankfeedaccount_read, accounting_bankfeedaccount_write, accounting_bankfeedtransaction_read, accounting_bankfeedtransaction_write, payment_payout_read, payment_refund_read, payment_link_read, payment_link_write, payment_subscription_read, payment_subscription_write, commerce_item_read, commerce_item_write, commerce_collection_read, commerce_collection_write, commerce_inventory_read, commerce_inventory_write, commerce_location_read, commerce_location_write, commerce_review_read, commerce_review_write, commerce_saleschannel_read, commerce_saleschannel_write, commerce_itemvariant_read, commerce_itemvariant_write, commerce_reservation_read, commerce_reservation_write, commerce_table_read, commerce_table_write, commerce_return_read, commerce_return_write, commerce_availability_read, commerce_availability_write, verification_package_read, verification_request_read, verification_request_write, assessment_package_read, assessment_package_write, assessment_order_write, ats_activity_read, ats_activity_write, ats_application_read, ats_application_write, ats_applicationstatus_read, ats_candidate_read, ats_candidate_write, ats_interview_read, ats_interview_write, ats_job_read, ats_job_write, ats_company_read, ats_company_write, ats_document_read, ats_document_write, ats_scorecard_read, ats_scorecard_write, crm_company_read, crm_company_write, crm_contact_read, crm_contact_write, crm_deal_read, crm_deal_write, crm_event_read, crm_event_write, crm_lead_read, crm_lead_write, crm_pipeline_read, crm_pipeline_write, crm_taxonomy_read, martech_list_read, martech_list_write, martech_member_read, martech_member_write, martech_campaign_read, martech_campaign_write, martech_report_read, martech_report_write, ticketing_customer_read, ticketing_customer_write, ticketing_ticket_read, ticketing_ticket_write, ticketing_note_read, ticketing_note_write, ticketing_category_read, ticketing_category_write, hris_employee_read, hris_employee_write, hris_group_read, hris_group_write, hris_payslip_read, hris_payslip_write, hris_timeoff_read, hris_timeoff_write, hris_timeshift_read, hris_timeshift_write, hris_attendance_read, hris_attendance_write, hris_company_read, hris_company_write, hris_location_read, hris_location_write, hris_device_read, hris_device_write, hris_deduction_read, hris_deduction_write, hris_benefit_read, hris_benefit_write, hris_bankaccount_read, hris_bankaccount_write, hris_document_read, hris_document_write, hris_taxonomy_read, hris_taxonomy_write, hris_job_read, hris_job_write, hris_payroll_read, hris_payroll_write, hris_paycode_read, hris_paycode_write, hris_earning_read, hris_earning_write, uc_call_read, uc_call_write, uc_contact_read, uc_contact_write, uc_fax_read, uc_fax_write, uc_comment_read, uc_comment_write, uc_recording_read, uc_scorecard_read, uc_scorecardtemplate_read, storage_file_read, storage_file_write, webhook, genai_model_read, genai_prompt_read, genai_prompt_write, genai_embedding_read, genai_embedding_write, genai_task_read, genai_task_write, genai_agent_read, genai_agent_write, genai_organization_read, genai_organization_write, genai_skill_read, genai_skill_write, genai_memory_read, genai_memory_write, messaging_message_read, messaging_message_write, messaging_channel_read, messaging_channel_write, messaging_event_read, messaging_event_write, kms_space_read, kms_space_write, kms_page_read, kms_page_write, kms_comment_read, kms_comment_write, task_project_read, task_project_write, task_task_read, task_task_write, task_change_read, task_comment_read, task_comment_write, scim_users_read, scim_users_write, scim_groups_read, scim_groups_write, lms_course_read, lms_course_write, lms_class_read, lms_class_write, lms_student_read, lms_student_write, lms_instructor_read, lms_instructor_write, lms_content_read, lms_content_write, lms_collection_read, lms_collection_write, lms_activity_read, lms_activity_write, repo_organization_read, repo_organization_write, repo_repository_read, repo_repository_write, repo_branch_read, repo_branch_write, repo_commit_read, repo_commit_write, repo_pullrequest_read, repo_pullrequest_write, metadata_metadata_read, metadata_metadata_write, calendar_calendar_read, calendar_calendar_write, calendar_event_read, calendar_event_write, calendar_busy_read, calendar_link_read, calendar_link_write, calendar_recording_read, calendar_recording_write, calendar_webinar_read, calendar_webinar_write, calendar_bot_read, calendar_bot_write, calendar_botevent_read, calendar_room_read, calendar_location_read, enrich_person_read, enrich_company_read, ads_ad_read, ads_ad_write, ads_campaign_read, ads_campaign_write, ads_group_read, ads_group_write, ads_report_read, ads_organization_read, ads_organization_write, ads_creative_read, ads_creative_write, ads_asset_read, ads_asset_write, ads_insertionorder_read, ads_insertionorder_write, ads_target_read, ads_promoted_read, ads_inventory_read, analytics_property_read, analytics_property_write, analytics_event_read, analytics_event_write, analytics_session_read, analytics_visitor_read, analytics_visitor_write, analytics_report_read, forms_form_read, forms_form_write, forms_submission_read, forms_submission_write, shipping_shipment_read, shipping_shipment_write, shipping_label_read, shipping_label_write, shipping_tracking_read, shipping_rate_read, shipping_rate_write, shipping_carrier_read, signing_document_read, signing_document_write, signing_signatory_read, signing_signatory_write, signing_template_read, signing_template_write, clubs_group_read, clubs_group_write, clubs_member_read, clubs_member_write, clubs_activity_read, clubs_activity_write, clubs_location_read, clubs_location_write, clubs_event_read, clubs_event_write, datastore_database_read, datastore_database_write, datastore_table_read, datastore_table_write, datastore_record_read, datastore_record_write, datastore_query_read, datastore_query_write, cdp_profile_read, cdp_profile_write, cdp_segment_read, cdp_segment_write, cdp_event_read, cdp_event_write, cdp_source_read, cdp_source_write, cdp_destination_read, cdp_destination_write, cdp_activation_read, cdp_activation_write, performance_cycle_read, performance_review_read, performance_review_write, performance_goal_read, performance_goal_write, performance_feedback_read, performance_feedback_write, social_post_read, social_post_write, social_profile_read, social_profile_write, social_review_read, social_review_write, social_insight_read, social_insight_write, social_comment_read, social_comment_write, legal_matter_read, legal_matter_write, legal_practicearea_read, legal_practicearea_write, legal_timeentry_read, legal_timeentry_write, legal_expense_read, legal_expense_write, compute_instance_read, compute_instance_write, compute_template_read, compute_template_write, compute_gputype_read, compute_region_read, compute_volume_read, compute_volume_write, compute_snapshot_read, compute_snapshot_write, compute_usage_read, compute_key_read, compute_key_write, compute_service_read, compute_service_write, compute_deployment_read, compute_deployment_write, compute_domain_read, compute_domain_write, compute_envvar_read, compute_envvar_write, healthcare_patient_read, healthcare_patient_write, healthcare_practitioner_read, healthcare_practitioner_write, healthcare_location_read, healthcare_location_write, healthcare_appointment_read, healthcare_appointment_write, healthcare_slot_read, healthcare_slot_write, healthcare_encounter_read, healthcare_encounter_write, healthcare_condition_read, healthcare_condition_write, healthcare_allergy_read, healthcare_allergy_write, healthcare_medication_read, healthcare_medication_write, healthcare_observation_read, healthcare_observation_write, healthcare_immunization_read, healthcare_immunization_write, healthcare_document_read, healthcare_document_write, healthcare_coverage_read, healthcare_coverage_write, healthcare_procedure_read, healthcare_procedure_write, healthcare_report_read, healthcare_report_write, healthcare_careplan_read, healthcare_careplan_write, healthcare_goal_read, healthcare_goal_write, property_listing_read, property_listing_write, property_unittype_read, property_guest_read, property_guest_write, property_reservation_read, property_reservation_write, property_availability_read, property_quote_read, property_quote_write, property_review_read, property_review_write, property_conversation_read, property_conversation_write, plm_part_read, plm_part_write, plm_bomline_read, plm_bomline_write, plm_document_read, plm_document_write, plm_change_read, plm_change_write, plm_category_read, plm_category_write, qms_issue_read, qms_issue_write, qms_action_read, qms_action_write, qms_inspection_read, qms_inspection_write, qms_audit_read, qms_audit_write
categoriesenumYesThe Integration categories that this connection supports Values: passthrough, hris, ats, auth, saml, crm, enrich, martech, ticketing, uc, accounting, storage, commerce, payment, genai, messaging, kms, task, scim, lms, repo, metadata, calendar, verification, ads, analytics, forms, shipping, assessment, signing, clubs, datastore, cdp, performance, social, legal, compute, healthcare, property, plm, qms
authobjectNoAn authentication object that represents a specific authorized user's connection to an integration.
auth.tokenstringNo
auth.access_tokenstringNo
auth.refresh_tokenstringNo
auth.expiry_datestring (date-time)No
auth.expires_innumberNo
auth.emailsstring[]No
auth.namestringNo
auth.user_idstringNo(reference to HrisEmployee)
auth.app_idstringNo
auth.client_idstringNo
auth.client_secretstringNo
auth.consumer_keystringNo
auth.consumer_secretstringNo
auth.statestringNo
auth.other_auth_infostring[]NoWhen integration.auth_type = "other", this field contains the authentication credentials in the same order as token_names
auth.api_urlstringNo
auth.authorize_urlstringNo
auth.token_urlstringNo
auth.refresh_urlstringNo
auth.pemstringNothe PEM X.509 certificate in Base64 ASCII format
auth.keystringNothe private KEY X.509 certificate in Base64 ASCII format
auth.refresh_token_expires_innumberNo
auth.refresh_token_expires_datestring (date-time)No
auth.dev_api_keystringNo
auth.audiencestringNo
is_pausedbooleanNoWhether this integration has exceed the monthly limit of the plan (read-only)
environmentstringNo
last_healthy_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
last_unhealthy_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) (read-only)
last_unhealthy_codestringNoThe HTTP status code that caused the last unhealthy status
secretsmanager_idstringNothe ID of the SecretsManager object
secretsmanager_keystringNothe key/path/name of the secret within the vault

TypeScript

TypeScript
export type Connection = {
	id?: string; // Unique identifier for this integration object
	created_at?: string-time; // The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	workspace_id?: string; // (reference to KmsSpace)
	integration_type: string; // The integration type
	integration_name?: string;
	external_xref?: string; // customer's user ID
	permissions: ( 'accounting_account_read' | 'accounting_account_write' | 'accounting_transaction_read' | 'accounting_transaction_write' | 'accounting_journal_read' | 'accounting_journal_write' | 'accounting_invoice_read' | 'accounting_invoice_write' | 'accounting_bill_read' | 'accounting_bill_write' | 'accounting_vendorcredit_read' | 'accounting_vendorcredit_write' | 'accounting_creditmemo_read' | 'accounting_creditmemo_write' | 'accounting_contact_read' | 'accounting_contact_write' | 'accounting_expense_read' | 'accounting_expense_write' | 'accounting_expensereport_read' | 'accounting_expensereport_write' | 'accounting_purchasereceipt_read' | 'accounting_purchasereceipt_write' | 'accounting_taxrate_read' | 'accounting_taxrate_write' | 'accounting_paymentterm_read' | 'accounting_paymentterm_write' | 'accounting_organization_read' | 'accounting_order_read' | 'accounting_order_write' | 'accounting_purchaseorder_read' | 'accounting_purchaseorder_write' | 'accounting_salesorder_read' | 'accounting_salesorder_write' | 'accounting_salesreceipt_read' | 'accounting_salesreceipt_write' | 'accounting_trialbalance_read' | 'accounting_trialbalance_write' | 'accounting_profitloss_read' | 'accounting_profitloss_write' | 'accounting_balancesheet_read' | 'accounting_balancesheet_write' | 'accounting_category_read' | 'accounting_category_write' | 'payment_payment_read' | 'payment_payment_write' | 'accounting_cashflow_read' | 'accounting_cashflow_write' | 'accounting_quote_read' | 'accounting_quote_write' | 'accounting_agedreceivable_read' | 'accounting_agedpayable_read' | 'accounting_project_read' | 'accounting_project_write' | 'accounting_bankfeedaccount_read' | 'accounting_bankfeedaccount_write' | 'accounting_bankfeedtransaction_read' | 'accounting_bankfeedtransaction_write' | 'payment_payout_read' | 'payment_refund_read' | 'payment_link_read' | 'payment_link_write' | 'payment_subscription_read' | 'payment_subscription_write' | 'commerce_item_read' | 'commerce_item_write' | 'commerce_collection_read' | 'commerce_collection_write' | 'commerce_inventory_read' | 'commerce_inventory_write' | 'commerce_location_read' | 'commerce_location_write' | 'commerce_review_read' | 'commerce_review_write' | 'commerce_saleschannel_read' | 'commerce_saleschannel_write' | 'commerce_itemvariant_read' | 'commerce_itemvariant_write' | 'commerce_reservation_read' | 'commerce_reservation_write' | 'commerce_table_read' | 'commerce_table_write' | 'commerce_return_read' | 'commerce_return_write' | 'commerce_availability_read' | 'commerce_availability_write' | 'verification_package_read' | 'verification_request_read' | 'verification_request_write' | 'assessment_package_read' | 'assessment_package_write' | 'assessment_order_write' | 'ats_activity_read' | 'ats_activity_write' | 'ats_application_read' | 'ats_application_write' | 'ats_applicationstatus_read' | 'ats_candidate_read' | 'ats_candidate_write' | 'ats_interview_read' | 'ats_interview_write' | 'ats_job_read' | 'ats_job_write' | 'ats_company_read' | 'ats_company_write' | 'ats_document_read' | 'ats_document_write' | 'ats_scorecard_read' | 'ats_scorecard_write' | 'crm_company_read' | 'crm_company_write' | 'crm_contact_read' | 'crm_contact_write' | 'crm_deal_read' | 'crm_deal_write' | 'crm_event_read' | 'crm_event_write' | 'crm_lead_read' | 'crm_lead_write' | 'crm_pipeline_read' | 'crm_pipeline_write' | 'crm_taxonomy_read' | 'martech_list_read' | 'martech_list_write' | 'martech_member_read' | 'martech_member_write' | 'martech_campaign_read' | 'martech_campaign_write' | 'martech_report_read' | 'martech_report_write' | 'ticketing_customer_read' | 'ticketing_customer_write' | 'ticketing_ticket_read' | 'ticketing_ticket_write' | 'ticketing_note_read' | 'ticketing_note_write' | 'ticketing_category_read' | 'ticketing_category_write' | 'hris_employee_read' | 'hris_employee_write' | 'hris_group_read' | 'hris_group_write' | 'hris_payslip_read' | 'hris_payslip_write' | 'hris_timeoff_read' | 'hris_timeoff_write' | 'hris_timeshift_read' | 'hris_timeshift_write' | 'hris_attendance_read' | 'hris_attendance_write' | 'hris_company_read' | 'hris_company_write' | 'hris_location_read' | 'hris_location_write' | 'hris_device_read' | 'hris_device_write' | 'hris_deduction_read' | 'hris_deduction_write' | 'hris_benefit_read' | 'hris_benefit_write' | 'hris_bankaccount_read' | 'hris_bankaccount_write' | 'hris_document_read' | 'hris_document_write' | 'hris_taxonomy_read' | 'hris_taxonomy_write' | 'hris_job_read' | 'hris_job_write' | 'hris_payroll_read' | 'hris_payroll_write' | 'hris_paycode_read' | 'hris_paycode_write' | 'hris_earning_read' | 'hris_earning_write' | 'uc_call_read' | 'uc_call_write' | 'uc_contact_read' | 'uc_contact_write' | 'uc_fax_read' | 'uc_fax_write' | 'uc_comment_read' | 'uc_comment_write' | 'uc_recording_read' | 'uc_scorecard_read' | 'uc_scorecardtemplate_read' | 'storage_file_read' | 'storage_file_write' | 'webhook' | 'genai_model_read' | 'genai_prompt_read' | 'genai_prompt_write' | 'genai_embedding_read' | 'genai_embedding_write' | 'genai_task_read' | 'genai_task_write' | 'genai_agent_read' | 'genai_agent_write' | 'genai_organization_read' | 'genai_organization_write' | 'genai_skill_read' | 'genai_skill_write' | 'genai_memory_read' | 'genai_memory_write' | 'messaging_message_read' | 'messaging_message_write' | 'messaging_channel_read' | 'messaging_channel_write' | 'messaging_event_read' | 'messaging_event_write' | 'kms_space_read' | 'kms_space_write' | 'kms_page_read' | 'kms_page_write' | 'kms_comment_read' | 'kms_comment_write' | 'task_project_read' | 'task_project_write' | 'task_task_read' | 'task_task_write' | 'task_change_read' | 'task_comment_read' | 'task_comment_write' | 'scim_users_read' | 'scim_users_write' | 'scim_groups_read' | 'scim_groups_write' | 'lms_course_read' | 'lms_course_write' | 'lms_class_read' | 'lms_class_write' | 'lms_student_read' | 'lms_student_write' | 'lms_instructor_read' | 'lms_instructor_write' | 'lms_content_read' | 'lms_content_write' | 'lms_collection_read' | 'lms_collection_write' | 'lms_activity_read' | 'lms_activity_write' | 'repo_organization_read' | 'repo_organization_write' | 'repo_repository_read' | 'repo_repository_write' | 'repo_branch_read' | 'repo_branch_write' | 'repo_commit_read' | 'repo_commit_write' | 'repo_pullrequest_read' | 'repo_pullrequest_write' | 'metadata_metadata_read' | 'metadata_metadata_write' | 'calendar_calendar_read' | 'calendar_calendar_write' | 'calendar_event_read' | 'calendar_event_write' | 'calendar_busy_read' | 'calendar_link_read' | 'calendar_link_write' | 'calendar_recording_read' | 'calendar_recording_write' | 'calendar_webinar_read' | 'calendar_webinar_write' | 'calendar_bot_read' | 'calendar_bot_write' | 'calendar_botevent_read' | 'calendar_room_read' | 'calendar_location_read' | 'enrich_person_read' | 'enrich_company_read' | 'ads_ad_read' | 'ads_ad_write' | 'ads_campaign_read' | 'ads_campaign_write' | 'ads_group_read' | 'ads_group_write' | 'ads_report_read' | 'ads_organization_read' | 'ads_organization_write' | 'ads_creative_read' | 'ads_creative_write' | 'ads_asset_read' | 'ads_asset_write' | 'ads_insertionorder_read' | 'ads_insertionorder_write' | 'ads_target_read' | 'ads_promoted_read' | 'ads_inventory_read' | 'analytics_property_read' | 'analytics_property_write' | 'analytics_event_read' | 'analytics_event_write' | 'analytics_session_read' | 'analytics_visitor_read' | 'analytics_visitor_write' | 'analytics_report_read' | 'forms_form_read' | 'forms_form_write' | 'forms_submission_read' | 'forms_submission_write' | 'shipping_shipment_read' | 'shipping_shipment_write' | 'shipping_label_read' | 'shipping_label_write' | 'shipping_tracking_read' | 'shipping_rate_read' | 'shipping_rate_write' | 'shipping_carrier_read' | 'signing_document_read' | 'signing_document_write' | 'signing_signatory_read' | 'signing_signatory_write' | 'signing_template_read' | 'signing_template_write' | 'clubs_group_read' | 'clubs_group_write' | 'clubs_member_read' | 'clubs_member_write' | 'clubs_activity_read' | 'clubs_activity_write' | 'clubs_location_read' | 'clubs_location_write' | 'clubs_event_read' | 'clubs_event_write' | 'datastore_database_read' | 'datastore_database_write' | 'datastore_table_read' | 'datastore_table_write' | 'datastore_record_read' | 'datastore_record_write' | 'datastore_query_read' | 'datastore_query_write' | 'cdp_profile_read' | 'cdp_profile_write' | 'cdp_segment_read' | 'cdp_segment_write' | 'cdp_event_read' | 'cdp_event_write' | 'cdp_source_read' | 'cdp_source_write' | 'cdp_destination_read' | 'cdp_destination_write' | 'cdp_activation_read' | 'cdp_activation_write' | 'performance_cycle_read' | 'performance_review_read' | 'performance_review_write' | 'performance_goal_read' | 'performance_goal_write' | 'performance_feedback_read' | 'performance_feedback_write' | 'social_post_read' | 'social_post_write' | 'social_profile_read' | 'social_profile_write' | 'social_review_read' | 'social_review_write' | 'social_insight_read' | 'social_insight_write' | 'social_comment_read' | 'social_comment_write' | 'legal_matter_read' | 'legal_matter_write' | 'legal_practicearea_read' | 'legal_practicearea_write' | 'legal_timeentry_read' | 'legal_timeentry_write' | 'legal_expense_read' | 'legal_expense_write' | 'compute_instance_read' | 'compute_instance_write' | 'compute_template_read' | 'compute_template_write' | 'compute_gputype_read' | 'compute_region_read' | 'compute_volume_read' | 'compute_volume_write' | 'compute_snapshot_read' | 'compute_snapshot_write' | 'compute_usage_read' | 'compute_key_read' | 'compute_key_write' | 'compute_service_read' | 'compute_service_write' | 'compute_deployment_read' | 'compute_deployment_write' | 'compute_domain_read' | 'compute_domain_write' | 'compute_envvar_read' | 'compute_envvar_write' | 'healthcare_patient_read' | 'healthcare_patient_write' | 'healthcare_practitioner_read' | 'healthcare_practitioner_write' | 'healthcare_location_read' | 'healthcare_location_write' | 'healthcare_appointment_read' | 'healthcare_appointment_write' | 'healthcare_slot_read' | 'healthcare_slot_write' | 'healthcare_encounter_read' | 'healthcare_encounter_write' | 'healthcare_condition_read' | 'healthcare_condition_write' | 'healthcare_allergy_read' | 'healthcare_allergy_write' | 'healthcare_medication_read' | 'healthcare_medication_write' | 'healthcare_observation_read' | 'healthcare_observation_write' | 'healthcare_immunization_read' | 'healthcare_immunization_write' | 'healthcare_document_read' | 'healthcare_document_write' | 'healthcare_coverage_read' | 'healthcare_coverage_write' | 'healthcare_procedure_read' | 'healthcare_procedure_write' | 'healthcare_report_read' | 'healthcare_report_write' | 'healthcare_careplan_read' | 'healthcare_careplan_write' | 'healthcare_goal_read' | 'healthcare_goal_write' | 'property_listing_read' | 'property_listing_write' | 'property_unittype_read' | 'property_guest_read' | 'property_guest_write' | 'property_reservation_read' | 'property_reservation_write' | 'property_availability_read' | 'property_quote_read' | 'property_quote_write' | 'property_review_read' | 'property_review_write' | 'property_conversation_read' | 'property_conversation_write' | 'plm_part_read' | 'plm_part_write' | 'plm_bomline_read' | 'plm_bomline_write' | 'plm_document_read' | 'plm_document_write' | 'plm_change_read' | 'plm_change_write' | 'plm_category_read' | 'plm_category_write' | 'qms_issue_read' | 'qms_issue_write' | 'qms_action_read' | 'qms_action_write' | 'qms_inspection_read' | 'qms_inspection_write' | 'qms_audit_read' | 'qms_audit_write' )[];
	categories: ( 'passthrough' | 'hris' | 'ats' | 'auth' | 'saml' | 'crm' | 'enrich' | 'martech' | 'ticketing' | 'uc' | 'accounting' | 'storage' | 'commerce' | 'payment' | 'genai' | 'messaging' | 'kms' | 'task' | 'scim' | 'lms' | 'repo' | 'metadata' | 'calendar' | 'verification' | 'ads' | 'analytics' | 'forms' | 'shipping' | 'assessment' | 'signing' | 'clubs' | 'datastore' | 'cdp' | 'performance' | 'social' | 'legal' | 'compute' | 'healthcare' | 'property' | 'plm' | 'qms' )[]; // The Integration categories that this connection supports
	auth?: {
		token?: string; 
		access_token?: string; 
		refresh_token?: string; 
		expiry_date?: string-time; 
		expires_in?: number; 
		emails?: any; 
		name?: string; 
		user_id?: string; // (reference to HrisEmployee) 
		app_id?: string; 
		client_id?: string; 
		client_secret?: string; 
		consumer_key?: string; 
		consumer_secret?: string; 
		meta?: any; 
		state?: string; 
		other_auth_info?: any; // When integration.auth_type = "other", this field contains the authentication credentials in the same order as token_names 
		api_url?: string; 
		authorize_url?: string; 
		token_url?: string; 
		refresh_url?: string; 
		pem?: string; // the PEM X.509 certificate in Base64 ASCII format 
		key?: string; // the private KEY X.509 certificate in Base64 ASCII format 
		refresh_token_expires_in?: number; 
		refresh_token_expires_date?: string-time; 
		dev_api_key?: string; 
		audience?: string; 
	}; // An authentication object that represents a specific authorized user's connection to an integration.
	is_paused?: boolean; // Whether this integration has exceed the monthly limit of the plan
	environment?: string;
	last_healthy_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	last_unhealthy_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	last_unhealthy_code?: string; // The HTTP status code that caused the last unhealthy status
	secretsmanager_id?: string; // the ID of the SecretsManager object
	secretsmanager_key?: string; // the key/path/name of the secret within the vault
} 

Zod

Zod
import { z } from 'zod';

export const ZodConnection = z.object({
	id: z.string().optional().describe("Unique identifier for this integration object"),
	created_at: z.string-time().optional().describe("The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	workspace_id: z.string().optional().describe("(reference to KmsSpace)"),
	integration_type: z.string().describe("The integration type"),
	integration_name: z.string().optional(),
	external_xref: z.string().optional().describe("customer's user ID"),
	permissions: z( 'accounting_account_read' | 'accounting_account_write' | 'accounting_transaction_read' | 'accounting_transaction_write' | 'accounting_journal_read' | 'accounting_journal_write' | 'accounting_invoice_read' | 'accounting_invoice_write' | 'accounting_bill_read' | 'accounting_bill_write' | 'accounting_vendorcredit_read' | 'accounting_vendorcredit_write' | 'accounting_creditmemo_read' | 'accounting_creditmemo_write' | 'accounting_contact_read' | 'accounting_contact_write' | 'accounting_expense_read' | 'accounting_expense_write' | 'accounting_expensereport_read' | 'accounting_expensereport_write' | 'accounting_purchasereceipt_read' | 'accounting_purchasereceipt_write' | 'accounting_taxrate_read' | 'accounting_taxrate_write' | 'accounting_paymentterm_read' | 'accounting_paymentterm_write' | 'accounting_organization_read' | 'accounting_order_read' | 'accounting_order_write' | 'accounting_purchaseorder_read' | 'accounting_purchaseorder_write' | 'accounting_salesorder_read' | 'accounting_salesorder_write' | 'accounting_salesreceipt_read' | 'accounting_salesreceipt_write' | 'accounting_trialbalance_read' | 'accounting_trialbalance_write' | 'accounting_profitloss_read' | 'accounting_profitloss_write' | 'accounting_balancesheet_read' | 'accounting_balancesheet_write' | 'accounting_category_read' | 'accounting_category_write' | 'payment_payment_read' | 'payment_payment_write' | 'accounting_cashflow_read' | 'accounting_cashflow_write' | 'accounting_quote_read' | 'accounting_quote_write' | 'accounting_agedreceivable_read' | 'accounting_agedpayable_read' | 'accounting_project_read' | 'accounting_project_write' | 'accounting_bankfeedaccount_read' | 'accounting_bankfeedaccount_write' | 'accounting_bankfeedtransaction_read' | 'accounting_bankfeedtransaction_write' | 'payment_payout_read' | 'payment_refund_read' | 'payment_link_read' | 'payment_link_write' | 'payment_subscription_read' | 'payment_subscription_write' | 'commerce_item_read' | 'commerce_item_write' | 'commerce_collection_read' | 'commerce_collection_write' | 'commerce_inventory_read' | 'commerce_inventory_write' | 'commerce_location_read' | 'commerce_location_write' | 'commerce_review_read' | 'commerce_review_write' | 'commerce_saleschannel_read' | 'commerce_saleschannel_write' | 'commerce_itemvariant_read' | 'commerce_itemvariant_write' | 'commerce_reservation_read' | 'commerce_reservation_write' | 'commerce_table_read' | 'commerce_table_write' | 'commerce_return_read' | 'commerce_return_write' | 'commerce_availability_read' | 'commerce_availability_write' | 'verification_package_read' | 'verification_request_read' | 'verification_request_write' | 'assessment_package_read' | 'assessment_package_write' | 'assessment_order_write' | 'ats_activity_read' | 'ats_activity_write' | 'ats_application_read' | 'ats_application_write' | 'ats_applicationstatus_read' | 'ats_candidate_read' | 'ats_candidate_write' | 'ats_interview_read' | 'ats_interview_write' | 'ats_job_read' | 'ats_job_write' | 'ats_company_read' | 'ats_company_write' | 'ats_document_read' | 'ats_document_write' | 'ats_scorecard_read' | 'ats_scorecard_write' | 'crm_company_read' | 'crm_company_write' | 'crm_contact_read' | 'crm_contact_write' | 'crm_deal_read' | 'crm_deal_write' | 'crm_event_read' | 'crm_event_write' | 'crm_lead_read' | 'crm_lead_write' | 'crm_pipeline_read' | 'crm_pipeline_write' | 'crm_taxonomy_read' | 'martech_list_read' | 'martech_list_write' | 'martech_member_read' | 'martech_member_write' | 'martech_campaign_read' | 'martech_campaign_write' | 'martech_report_read' | 'martech_report_write' | 'ticketing_customer_read' | 'ticketing_customer_write' | 'ticketing_ticket_read' | 'ticketing_ticket_write' | 'ticketing_note_read' | 'ticketing_note_write' | 'ticketing_category_read' | 'ticketing_category_write' | 'hris_employee_read' | 'hris_employee_write' | 'hris_group_read' | 'hris_group_write' | 'hris_payslip_read' | 'hris_payslip_write' | 'hris_timeoff_read' | 'hris_timeoff_write' | 'hris_timeshift_read' | 'hris_timeshift_write' | 'hris_attendance_read' | 'hris_attendance_write' | 'hris_company_read' | 'hris_company_write' | 'hris_location_read' | 'hris_location_write' | 'hris_device_read' | 'hris_device_write' | 'hris_deduction_read' | 'hris_deduction_write' | 'hris_benefit_read' | 'hris_benefit_write' | 'hris_bankaccount_read' | 'hris_bankaccount_write' | 'hris_document_read' | 'hris_document_write' | 'hris_taxonomy_read' | 'hris_taxonomy_write' | 'hris_job_read' | 'hris_job_write' | 'hris_payroll_read' | 'hris_payroll_write' | 'hris_paycode_read' | 'hris_paycode_write' | 'hris_earning_read' | 'hris_earning_write' | 'uc_call_read' | 'uc_call_write' | 'uc_contact_read' | 'uc_contact_write' | 'uc_fax_read' | 'uc_fax_write' | 'uc_comment_read' | 'uc_comment_write' | 'uc_recording_read' | 'uc_scorecard_read' | 'uc_scorecardtemplate_read' | 'storage_file_read' | 'storage_file_write' | 'webhook' | 'genai_model_read' | 'genai_prompt_read' | 'genai_prompt_write' | 'genai_embedding_read' | 'genai_embedding_write' | 'genai_task_read' | 'genai_task_write' | 'genai_agent_read' | 'genai_agent_write' | 'genai_organization_read' | 'genai_organization_write' | 'genai_skill_read' | 'genai_skill_write' | 'genai_memory_read' | 'genai_memory_write' | 'messaging_message_read' | 'messaging_message_write' | 'messaging_channel_read' | 'messaging_channel_write' | 'messaging_event_read' | 'messaging_event_write' | 'kms_space_read' | 'kms_space_write' | 'kms_page_read' | 'kms_page_write' | 'kms_comment_read' | 'kms_comment_write' | 'task_project_read' | 'task_project_write' | 'task_task_read' | 'task_task_write' | 'task_change_read' | 'task_comment_read' | 'task_comment_write' | 'scim_users_read' | 'scim_users_write' | 'scim_groups_read' | 'scim_groups_write' | 'lms_course_read' | 'lms_course_write' | 'lms_class_read' | 'lms_class_write' | 'lms_student_read' | 'lms_student_write' | 'lms_instructor_read' | 'lms_instructor_write' | 'lms_content_read' | 'lms_content_write' | 'lms_collection_read' | 'lms_collection_write' | 'lms_activity_read' | 'lms_activity_write' | 'repo_organization_read' | 'repo_organization_write' | 'repo_repository_read' | 'repo_repository_write' | 'repo_branch_read' | 'repo_branch_write' | 'repo_commit_read' | 'repo_commit_write' | 'repo_pullrequest_read' | 'repo_pullrequest_write' | 'metadata_metadata_read' | 'metadata_metadata_write' | 'calendar_calendar_read' | 'calendar_calendar_write' | 'calendar_event_read' | 'calendar_event_write' | 'calendar_busy_read' | 'calendar_link_read' | 'calendar_link_write' | 'calendar_recording_read' | 'calendar_recording_write' | 'calendar_webinar_read' | 'calendar_webinar_write' | 'calendar_bot_read' | 'calendar_bot_write' | 'calendar_botevent_read' | 'calendar_room_read' | 'calendar_location_read' | 'enrich_person_read' | 'enrich_company_read' | 'ads_ad_read' | 'ads_ad_write' | 'ads_campaign_read' | 'ads_campaign_write' | 'ads_group_read' | 'ads_group_write' | 'ads_report_read' | 'ads_organization_read' | 'ads_organization_write' | 'ads_creative_read' | 'ads_creative_write' | 'ads_asset_read' | 'ads_asset_write' | 'ads_insertionorder_read' | 'ads_insertionorder_write' | 'ads_target_read' | 'ads_promoted_read' | 'ads_inventory_read' | 'analytics_property_read' | 'analytics_property_write' | 'analytics_event_read' | 'analytics_event_write' | 'analytics_session_read' | 'analytics_visitor_read' | 'analytics_visitor_write' | 'analytics_report_read' | 'forms_form_read' | 'forms_form_write' | 'forms_submission_read' | 'forms_submission_write' | 'shipping_shipment_read' | 'shipping_shipment_write' | 'shipping_label_read' | 'shipping_label_write' | 'shipping_tracking_read' | 'shipping_rate_read' | 'shipping_rate_write' | 'shipping_carrier_read' | 'signing_document_read' | 'signing_document_write' | 'signing_signatory_read' | 'signing_signatory_write' | 'signing_template_read' | 'signing_template_write' | 'clubs_group_read' | 'clubs_group_write' | 'clubs_member_read' | 'clubs_member_write' | 'clubs_activity_read' | 'clubs_activity_write' | 'clubs_location_read' | 'clubs_location_write' | 'clubs_event_read' | 'clubs_event_write' | 'datastore_database_read' | 'datastore_database_write' | 'datastore_table_read' | 'datastore_table_write' | 'datastore_record_read' | 'datastore_record_write' | 'datastore_query_read' | 'datastore_query_write' | 'cdp_profile_read' | 'cdp_profile_write' | 'cdp_segment_read' | 'cdp_segment_write' | 'cdp_event_read' | 'cdp_event_write' | 'cdp_source_read' | 'cdp_source_write' | 'cdp_destination_read' | 'cdp_destination_write' | 'cdp_activation_read' | 'cdp_activation_write' | 'performance_cycle_read' | 'performance_review_read' | 'performance_review_write' | 'performance_goal_read' | 'performance_goal_write' | 'performance_feedback_read' | 'performance_feedback_write' | 'social_post_read' | 'social_post_write' | 'social_profile_read' | 'social_profile_write' | 'social_review_read' | 'social_review_write' | 'social_insight_read' | 'social_insight_write' | 'social_comment_read' | 'social_comment_write' | 'legal_matter_read' | 'legal_matter_write' | 'legal_practicearea_read' | 'legal_practicearea_write' | 'legal_timeentry_read' | 'legal_timeentry_write' | 'legal_expense_read' | 'legal_expense_write' | 'compute_instance_read' | 'compute_instance_write' | 'compute_template_read' | 'compute_template_write' | 'compute_gputype_read' | 'compute_region_read' | 'compute_volume_read' | 'compute_volume_write' | 'compute_snapshot_read' | 'compute_snapshot_write' | 'compute_usage_read' | 'compute_key_read' | 'compute_key_write' | 'compute_service_read' | 'compute_service_write' | 'compute_deployment_read' | 'compute_deployment_write' | 'compute_domain_read' | 'compute_domain_write' | 'compute_envvar_read' | 'compute_envvar_write' | 'healthcare_patient_read' | 'healthcare_patient_write' | 'healthcare_practitioner_read' | 'healthcare_practitioner_write' | 'healthcare_location_read' | 'healthcare_location_write' | 'healthcare_appointment_read' | 'healthcare_appointment_write' | 'healthcare_slot_read' | 'healthcare_slot_write' | 'healthcare_encounter_read' | 'healthcare_encounter_write' | 'healthcare_condition_read' | 'healthcare_condition_write' | 'healthcare_allergy_read' | 'healthcare_allergy_write' | 'healthcare_medication_read' | 'healthcare_medication_write' | 'healthcare_observation_read' | 'healthcare_observation_write' | 'healthcare_immunization_read' | 'healthcare_immunization_write' | 'healthcare_document_read' | 'healthcare_document_write' | 'healthcare_coverage_read' | 'healthcare_coverage_write' | 'healthcare_procedure_read' | 'healthcare_procedure_write' | 'healthcare_report_read' | 'healthcare_report_write' | 'healthcare_careplan_read' | 'healthcare_careplan_write' | 'healthcare_goal_read' | 'healthcare_goal_write' | 'property_listing_read' | 'property_listing_write' | 'property_unittype_read' | 'property_guest_read' | 'property_guest_write' | 'property_reservation_read' | 'property_reservation_write' | 'property_availability_read' | 'property_quote_read' | 'property_quote_write' | 'property_review_read' | 'property_review_write' | 'property_conversation_read' | 'property_conversation_write' | 'plm_part_read' | 'plm_part_write' | 'plm_bomline_read' | 'plm_bomline_write' | 'plm_document_read' | 'plm_document_write' | 'plm_change_read' | 'plm_change_write' | 'plm_category_read' | 'plm_category_write' | 'qms_issue_read' | 'qms_issue_write' | 'qms_action_read' | 'qms_action_write' | 'qms_inspection_read' | 'qms_inspection_write' | 'qms_audit_read' | 'qms_audit_write' ),
	categories: z( 'passthrough' | 'hris' | 'ats' | 'auth' | 'saml' | 'crm' | 'enrich' | 'martech' | 'ticketing' | 'uc' | 'accounting' | 'storage' | 'commerce' | 'payment' | 'genai' | 'messaging' | 'kms' | 'task' | 'scim' | 'lms' | 'repo' | 'metadata' | 'calendar' | 'verification' | 'ads' | 'analytics' | 'forms' | 'shipping' | 'assessment' | 'signing' | 'clubs' | 'datastore' | 'cdp' | 'performance' | 'social' | 'legal' | 'compute' | 'healthcare' | 'property' | 'plm' | 'qms' ).describe("The Integration categories that this connection supports"),
	auth: z.object({
			token: z.string().optional(),
			access_token: z.string().optional(),
			refresh_token: z.string().optional(),
			expiry_date: z.string-time().optional(),
			expires_in: z.number().optional(),
			emails: z.unknown().optional(),
			name: z.string().optional(),
			user_id: z.string().optional().describe("(reference to HrisEmployee)"),
			app_id: z.string().optional(),
			client_id: z.string().optional(),
			client_secret: z.string().optional(),
			consumer_key: z.string().optional(),
			consumer_secret: z.string().optional(),
			meta: z.unknown().optional(),
			state: z.string().optional(),
			other_auth_info: z.unknown().optional().describe("When integration.auth_type = "other", this field contains the authentication credentials in the same order as token_names"),
			api_url: z.string().optional(),
			authorize_url: z.string().optional(),
			token_url: z.string().optional(),
			refresh_url: z.string().optional(),
			pem: z.string().optional().describe("the PEM X.509 certificate in Base64 ASCII format"),
			key: z.string().optional().describe("the private KEY X.509 certificate in Base64 ASCII format"),
			refresh_token_expires_in: z.number().optional(),
			refresh_token_expires_date: z.string-time().optional(),
			dev_api_key: z.string().optional(),
			audience: z.string().optional()
}).optional().describe("An authentication object that represents a specific authorized user's connection to an integration."),
	is_paused: z.boolean().optional().describe("Whether this integration has exceed the monthly limit of the plan"),
	environment: z.string().optional(),
	last_healthy_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	last_unhealthy_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	last_unhealthy_code: z.string().optional().describe("The HTTP status code that caused the last unhealthy status"),
	secretsmanager_id: z.string().optional().describe("the ID of the SecretsManager object"),
	secretsmanager_key: z.string().optional().describe("the key/path/name of the secret within the vault")
});

Python

Python
import dataclasses

@dataclasses.dataclass
class ConnectionPermissions(str, Enum):
	accounting_account_read = 'accounting_account_read'
	accounting_account_write = 'accounting_account_write'
	accounting_transaction_read = 'accounting_transaction_read'
	accounting_transaction_write = 'accounting_transaction_write'
	accounting_journal_read = 'accounting_journal_read'
	accounting_journal_write = 'accounting_journal_write'
	accounting_invoice_read = 'accounting_invoice_read'
	accounting_invoice_write = 'accounting_invoice_write'
	accounting_bill_read = 'accounting_bill_read'
	accounting_bill_write = 'accounting_bill_write'
	accounting_vendorcredit_read = 'accounting_vendorcredit_read'
	accounting_vendorcredit_write = 'accounting_vendorcredit_write'
	accounting_creditmemo_read = 'accounting_creditmemo_read'
	accounting_creditmemo_write = 'accounting_creditmemo_write'
	accounting_contact_read = 'accounting_contact_read'
	accounting_contact_write = 'accounting_contact_write'
	accounting_expense_read = 'accounting_expense_read'
	accounting_expense_write = 'accounting_expense_write'
	accounting_expensereport_read = 'accounting_expensereport_read'
	accounting_expensereport_write = 'accounting_expensereport_write'
	accounting_purchasereceipt_read = 'accounting_purchasereceipt_read'
	accounting_purchasereceipt_write = 'accounting_purchasereceipt_write'
	accounting_taxrate_read = 'accounting_taxrate_read'
	accounting_taxrate_write = 'accounting_taxrate_write'
	accounting_paymentterm_read = 'accounting_paymentterm_read'
	accounting_paymentterm_write = 'accounting_paymentterm_write'
	accounting_organization_read = 'accounting_organization_read'
	accounting_order_read = 'accounting_order_read'
	accounting_order_write = 'accounting_order_write'
	accounting_purchaseorder_read = 'accounting_purchaseorder_read'
	accounting_purchaseorder_write = 'accounting_purchaseorder_write'
	accounting_salesorder_read = 'accounting_salesorder_read'
	accounting_salesorder_write = 'accounting_salesorder_write'
	accounting_salesreceipt_read = 'accounting_salesreceipt_read'
	accounting_salesreceipt_write = 'accounting_salesreceipt_write'
	accounting_trialbalance_read = 'accounting_trialbalance_read'
	accounting_trialbalance_write = 'accounting_trialbalance_write'
	accounting_profitloss_read = 'accounting_profitloss_read'
	accounting_profitloss_write = 'accounting_profitloss_write'
	accounting_balancesheet_read = 'accounting_balancesheet_read'
	accounting_balancesheet_write = 'accounting_balancesheet_write'
	accounting_category_read = 'accounting_category_read'
	accounting_category_write = 'accounting_category_write'
	payment_payment_read = 'payment_payment_read'
	payment_payment_write = 'payment_payment_write'
	accounting_cashflow_read = 'accounting_cashflow_read'
	accounting_cashflow_write = 'accounting_cashflow_write'
	accounting_quote_read = 'accounting_quote_read'
	accounting_quote_write = 'accounting_quote_write'
	accounting_agedreceivable_read = 'accounting_agedreceivable_read'
	accounting_agedpayable_read = 'accounting_agedpayable_read'
	accounting_project_read = 'accounting_project_read'
	accounting_project_write = 'accounting_project_write'
	accounting_bankfeedaccount_read = 'accounting_bankfeedaccount_read'
	accounting_bankfeedaccount_write = 'accounting_bankfeedaccount_write'
	accounting_bankfeedtransaction_read = 'accounting_bankfeedtransaction_read'
	accounting_bankfeedtransaction_write = 'accounting_bankfeedtransaction_write'
	payment_payout_read = 'payment_payout_read'
	payment_refund_read = 'payment_refund_read'
	payment_link_read = 'payment_link_read'
	payment_link_write = 'payment_link_write'
	payment_subscription_read = 'payment_subscription_read'
	payment_subscription_write = 'payment_subscription_write'
	commerce_item_read = 'commerce_item_read'
	commerce_item_write = 'commerce_item_write'
	commerce_collection_read = 'commerce_collection_read'
	commerce_collection_write = 'commerce_collection_write'
	commerce_inventory_read = 'commerce_inventory_read'
	commerce_inventory_write = 'commerce_inventory_write'
	commerce_location_read = 'commerce_location_read'
	commerce_location_write = 'commerce_location_write'
	commerce_review_read = 'commerce_review_read'
	commerce_review_write = 'commerce_review_write'
	commerce_saleschannel_read = 'commerce_saleschannel_read'
	commerce_saleschannel_write = 'commerce_saleschannel_write'
	commerce_itemvariant_read = 'commerce_itemvariant_read'
	commerce_itemvariant_write = 'commerce_itemvariant_write'
	commerce_reservation_read = 'commerce_reservation_read'
	commerce_reservation_write = 'commerce_reservation_write'
	commerce_table_read = 'commerce_table_read'
	commerce_table_write = 'commerce_table_write'
	commerce_return_read = 'commerce_return_read'
	commerce_return_write = 'commerce_return_write'
	commerce_availability_read = 'commerce_availability_read'
	commerce_availability_write = 'commerce_availability_write'
	verification_package_read = 'verification_package_read'
	verification_request_read = 'verification_request_read'
	verification_request_write = 'verification_request_write'
	assessment_package_read = 'assessment_package_read'
	assessment_package_write = 'assessment_package_write'
	assessment_order_write = 'assessment_order_write'
	ats_activity_read = 'ats_activity_read'
	ats_activity_write = 'ats_activity_write'
	ats_application_read = 'ats_application_read'
	ats_application_write = 'ats_application_write'
	ats_applicationstatus_read = 'ats_applicationstatus_read'
	ats_candidate_read = 'ats_candidate_read'
	ats_candidate_write = 'ats_candidate_write'
	ats_interview_read = 'ats_interview_read'
	ats_interview_write = 'ats_interview_write'
	ats_job_read = 'ats_job_read'
	ats_job_write = 'ats_job_write'
	ats_company_read = 'ats_company_read'
	ats_company_write = 'ats_company_write'
	ats_document_read = 'ats_document_read'
	ats_document_write = 'ats_document_write'
	ats_scorecard_read = 'ats_scorecard_read'
	ats_scorecard_write = 'ats_scorecard_write'
	crm_company_read = 'crm_company_read'
	crm_company_write = 'crm_company_write'
	crm_contact_read = 'crm_contact_read'
	crm_contact_write = 'crm_contact_write'
	crm_deal_read = 'crm_deal_read'
	crm_deal_write = 'crm_deal_write'
	crm_event_read = 'crm_event_read'
	crm_event_write = 'crm_event_write'
	crm_lead_read = 'crm_lead_read'
	crm_lead_write = 'crm_lead_write'
	crm_pipeline_read = 'crm_pipeline_read'
	crm_pipeline_write = 'crm_pipeline_write'
	crm_taxonomy_read = 'crm_taxonomy_read'
	martech_list_read = 'martech_list_read'
	martech_list_write = 'martech_list_write'
	martech_member_read = 'martech_member_read'
	martech_member_write = 'martech_member_write'
	martech_campaign_read = 'martech_campaign_read'
	martech_campaign_write = 'martech_campaign_write'
	martech_report_read = 'martech_report_read'
	martech_report_write = 'martech_report_write'
	ticketing_customer_read = 'ticketing_customer_read'
	ticketing_customer_write = 'ticketing_customer_write'
	ticketing_ticket_read = 'ticketing_ticket_read'
	ticketing_ticket_write = 'ticketing_ticket_write'
	ticketing_note_read = 'ticketing_note_read'
	ticketing_note_write = 'ticketing_note_write'
	ticketing_category_read = 'ticketing_category_read'
	ticketing_category_write = 'ticketing_category_write'
	hris_employee_read = 'hris_employee_read'
	hris_employee_write = 'hris_employee_write'
	hris_group_read = 'hris_group_read'
	hris_group_write = 'hris_group_write'
	hris_payslip_read = 'hris_payslip_read'
	hris_payslip_write = 'hris_payslip_write'
	hris_timeoff_read = 'hris_timeoff_read'
	hris_timeoff_write = 'hris_timeoff_write'
	hris_timeshift_read = 'hris_timeshift_read'
	hris_timeshift_write = 'hris_timeshift_write'
	hris_attendance_read = 'hris_attendance_read'
	hris_attendance_write = 'hris_attendance_write'
	hris_company_read = 'hris_company_read'
	hris_company_write = 'hris_company_write'
	hris_location_read = 'hris_location_read'
	hris_location_write = 'hris_location_write'
	hris_device_read = 'hris_device_read'
	hris_device_write = 'hris_device_write'
	hris_deduction_read = 'hris_deduction_read'
	hris_deduction_write = 'hris_deduction_write'
	hris_benefit_read = 'hris_benefit_read'
	hris_benefit_write = 'hris_benefit_write'
	hris_bankaccount_read = 'hris_bankaccount_read'
	hris_bankaccount_write = 'hris_bankaccount_write'
	hris_document_read = 'hris_document_read'
	hris_document_write = 'hris_document_write'
	hris_taxonomy_read = 'hris_taxonomy_read'
	hris_taxonomy_write = 'hris_taxonomy_write'
	hris_job_read = 'hris_job_read'
	hris_job_write = 'hris_job_write'
	hris_payroll_read = 'hris_payroll_read'
	hris_payroll_write = 'hris_payroll_write'
	hris_paycode_read = 'hris_paycode_read'
	hris_paycode_write = 'hris_paycode_write'
	hris_earning_read = 'hris_earning_read'
	hris_earning_write = 'hris_earning_write'
	uc_call_read = 'uc_call_read'
	uc_call_write = 'uc_call_write'
	uc_contact_read = 'uc_contact_read'
	uc_contact_write = 'uc_contact_write'
	uc_fax_read = 'uc_fax_read'
	uc_fax_write = 'uc_fax_write'
	uc_comment_read = 'uc_comment_read'
	uc_comment_write = 'uc_comment_write'
	uc_recording_read = 'uc_recording_read'
	uc_scorecard_read = 'uc_scorecard_read'
	uc_scorecardtemplate_read = 'uc_scorecardtemplate_read'
	storage_file_read = 'storage_file_read'
	storage_file_write = 'storage_file_write'
	webhook = 'webhook'
	genai_model_read = 'genai_model_read'
	genai_prompt_read = 'genai_prompt_read'
	genai_prompt_write = 'genai_prompt_write'
	genai_embedding_read = 'genai_embedding_read'
	genai_embedding_write = 'genai_embedding_write'
	genai_task_read = 'genai_task_read'
	genai_task_write = 'genai_task_write'
	genai_agent_read = 'genai_agent_read'
	genai_agent_write = 'genai_agent_write'
	genai_organization_read = 'genai_organization_read'
	genai_organization_write = 'genai_organization_write'
	genai_skill_read = 'genai_skill_read'
	genai_skill_write = 'genai_skill_write'
	genai_memory_read = 'genai_memory_read'
	genai_memory_write = 'genai_memory_write'
	messaging_message_read = 'messaging_message_read'
	messaging_message_write = 'messaging_message_write'
	messaging_channel_read = 'messaging_channel_read'
	messaging_channel_write = 'messaging_channel_write'
	messaging_event_read = 'messaging_event_read'
	messaging_event_write = 'messaging_event_write'
	kms_space_read = 'kms_space_read'
	kms_space_write = 'kms_space_write'
	kms_page_read = 'kms_page_read'
	kms_page_write = 'kms_page_write'
	kms_comment_read = 'kms_comment_read'
	kms_comment_write = 'kms_comment_write'
	task_project_read = 'task_project_read'
	task_project_write = 'task_project_write'
	task_task_read = 'task_task_read'
	task_task_write = 'task_task_write'
	task_change_read = 'task_change_read'
	task_comment_read = 'task_comment_read'
	task_comment_write = 'task_comment_write'
	scim_users_read = 'scim_users_read'
	scim_users_write = 'scim_users_write'
	scim_groups_read = 'scim_groups_read'
	scim_groups_write = 'scim_groups_write'
	lms_course_read = 'lms_course_read'
	lms_course_write = 'lms_course_write'
	lms_class_read = 'lms_class_read'
	lms_class_write = 'lms_class_write'
	lms_student_read = 'lms_student_read'
	lms_student_write = 'lms_student_write'
	lms_instructor_read = 'lms_instructor_read'
	lms_instructor_write = 'lms_instructor_write'
	lms_content_read = 'lms_content_read'
	lms_content_write = 'lms_content_write'
	lms_collection_read = 'lms_collection_read'
	lms_collection_write = 'lms_collection_write'
	lms_activity_read = 'lms_activity_read'
	lms_activity_write = 'lms_activity_write'
	repo_organization_read = 'repo_organization_read'
	repo_organization_write = 'repo_organization_write'
	repo_repository_read = 'repo_repository_read'
	repo_repository_write = 'repo_repository_write'
	repo_branch_read = 'repo_branch_read'
	repo_branch_write = 'repo_branch_write'
	repo_commit_read = 'repo_commit_read'
	repo_commit_write = 'repo_commit_write'
	repo_pullrequest_read = 'repo_pullrequest_read'
	repo_pullrequest_write = 'repo_pullrequest_write'
	metadata_metadata_read = 'metadata_metadata_read'
	metadata_metadata_write = 'metadata_metadata_write'
	calendar_calendar_read = 'calendar_calendar_read'
	calendar_calendar_write = 'calendar_calendar_write'
	calendar_event_read = 'calendar_event_read'
	calendar_event_write = 'calendar_event_write'
	calendar_busy_read = 'calendar_busy_read'
	calendar_link_read = 'calendar_link_read'
	calendar_link_write = 'calendar_link_write'
	calendar_recording_read = 'calendar_recording_read'
	calendar_recording_write = 'calendar_recording_write'
	calendar_webinar_read = 'calendar_webinar_read'
	calendar_webinar_write = 'calendar_webinar_write'
	calendar_bot_read = 'calendar_bot_read'
	calendar_bot_write = 'calendar_bot_write'
	calendar_botevent_read = 'calendar_botevent_read'
	calendar_room_read = 'calendar_room_read'
	calendar_location_read = 'calendar_location_read'
	enrich_person_read = 'enrich_person_read'
	enrich_company_read = 'enrich_company_read'
	ads_ad_read = 'ads_ad_read'
	ads_ad_write = 'ads_ad_write'
	ads_campaign_read = 'ads_campaign_read'
	ads_campaign_write = 'ads_campaign_write'
	ads_group_read = 'ads_group_read'
	ads_group_write = 'ads_group_write'
	ads_report_read = 'ads_report_read'
	ads_organization_read = 'ads_organization_read'
	ads_organization_write = 'ads_organization_write'
	ads_creative_read = 'ads_creative_read'
	ads_creative_write = 'ads_creative_write'
	ads_asset_read = 'ads_asset_read'
	ads_asset_write = 'ads_asset_write'
	ads_insertionorder_read = 'ads_insertionorder_read'
	ads_insertionorder_write = 'ads_insertionorder_write'
	ads_target_read = 'ads_target_read'
	ads_promoted_read = 'ads_promoted_read'
	ads_inventory_read = 'ads_inventory_read'
	analytics_property_read = 'analytics_property_read'
	analytics_property_write = 'analytics_property_write'
	analytics_event_read = 'analytics_event_read'
	analytics_event_write = 'analytics_event_write'
	analytics_session_read = 'analytics_session_read'
	analytics_visitor_read = 'analytics_visitor_read'
	analytics_visitor_write = 'analytics_visitor_write'
	analytics_report_read = 'analytics_report_read'
	forms_form_read = 'forms_form_read'
	forms_form_write = 'forms_form_write'
	forms_submission_read = 'forms_submission_read'
	forms_submission_write = 'forms_submission_write'
	shipping_shipment_read = 'shipping_shipment_read'
	shipping_shipment_write = 'shipping_shipment_write'
	shipping_label_read = 'shipping_label_read'
	shipping_label_write = 'shipping_label_write'
	shipping_tracking_read = 'shipping_tracking_read'
	shipping_rate_read = 'shipping_rate_read'
	shipping_rate_write = 'shipping_rate_write'
	shipping_carrier_read = 'shipping_carrier_read'
	signing_document_read = 'signing_document_read'
	signing_document_write = 'signing_document_write'
	signing_signatory_read = 'signing_signatory_read'
	signing_signatory_write = 'signing_signatory_write'
	signing_template_read = 'signing_template_read'
	signing_template_write = 'signing_template_write'
	clubs_group_read = 'clubs_group_read'
	clubs_group_write = 'clubs_group_write'
	clubs_member_read = 'clubs_member_read'
	clubs_member_write = 'clubs_member_write'
	clubs_activity_read = 'clubs_activity_read'
	clubs_activity_write = 'clubs_activity_write'
	clubs_location_read = 'clubs_location_read'
	clubs_location_write = 'clubs_location_write'
	clubs_event_read = 'clubs_event_read'
	clubs_event_write = 'clubs_event_write'
	datastore_database_read = 'datastore_database_read'
	datastore_database_write = 'datastore_database_write'
	datastore_table_read = 'datastore_table_read'
	datastore_table_write = 'datastore_table_write'
	datastore_record_read = 'datastore_record_read'
	datastore_record_write = 'datastore_record_write'
	datastore_query_read = 'datastore_query_read'
	datastore_query_write = 'datastore_query_write'
	cdp_profile_read = 'cdp_profile_read'
	cdp_profile_write = 'cdp_profile_write'
	cdp_segment_read = 'cdp_segment_read'
	cdp_segment_write = 'cdp_segment_write'
	cdp_event_read = 'cdp_event_read'
	cdp_event_write = 'cdp_event_write'
	cdp_source_read = 'cdp_source_read'
	cdp_source_write = 'cdp_source_write'
	cdp_destination_read = 'cdp_destination_read'
	cdp_destination_write = 'cdp_destination_write'
	cdp_activation_read = 'cdp_activation_read'
	cdp_activation_write = 'cdp_activation_write'
	performance_cycle_read = 'performance_cycle_read'
	performance_review_read = 'performance_review_read'
	performance_review_write = 'performance_review_write'
	performance_goal_read = 'performance_goal_read'
	performance_goal_write = 'performance_goal_write'
	performance_feedback_read = 'performance_feedback_read'
	performance_feedback_write = 'performance_feedback_write'
	social_post_read = 'social_post_read'
	social_post_write = 'social_post_write'
	social_profile_read = 'social_profile_read'
	social_profile_write = 'social_profile_write'
	social_review_read = 'social_review_read'
	social_review_write = 'social_review_write'
	social_insight_read = 'social_insight_read'
	social_insight_write = 'social_insight_write'
	social_comment_read = 'social_comment_read'
	social_comment_write = 'social_comment_write'
	legal_matter_read = 'legal_matter_read'
	legal_matter_write = 'legal_matter_write'
	legal_practicearea_read = 'legal_practicearea_read'
	legal_practicearea_write = 'legal_practicearea_write'
	legal_timeentry_read = 'legal_timeentry_read'
	legal_timeentry_write = 'legal_timeentry_write'
	legal_expense_read = 'legal_expense_read'
	legal_expense_write = 'legal_expense_write'
	compute_instance_read = 'compute_instance_read'
	compute_instance_write = 'compute_instance_write'
	compute_template_read = 'compute_template_read'
	compute_template_write = 'compute_template_write'
	compute_gputype_read = 'compute_gputype_read'
	compute_region_read = 'compute_region_read'
	compute_volume_read = 'compute_volume_read'
	compute_volume_write = 'compute_volume_write'
	compute_snapshot_read = 'compute_snapshot_read'
	compute_snapshot_write = 'compute_snapshot_write'
	compute_usage_read = 'compute_usage_read'
	compute_key_read = 'compute_key_read'
	compute_key_write = 'compute_key_write'
	compute_service_read = 'compute_service_read'
	compute_service_write = 'compute_service_write'
	compute_deployment_read = 'compute_deployment_read'
	compute_deployment_write = 'compute_deployment_write'
	compute_domain_read = 'compute_domain_read'
	compute_domain_write = 'compute_domain_write'
	compute_envvar_read = 'compute_envvar_read'
	compute_envvar_write = 'compute_envvar_write'
	healthcare_patient_read = 'healthcare_patient_read'
	healthcare_patient_write = 'healthcare_patient_write'
	healthcare_practitioner_read = 'healthcare_practitioner_read'
	healthcare_practitioner_write = 'healthcare_practitioner_write'
	healthcare_location_read = 'healthcare_location_read'
	healthcare_location_write = 'healthcare_location_write'
	healthcare_appointment_read = 'healthcare_appointment_read'
	healthcare_appointment_write = 'healthcare_appointment_write'
	healthcare_slot_read = 'healthcare_slot_read'
	healthcare_slot_write = 'healthcare_slot_write'
	healthcare_encounter_read = 'healthcare_encounter_read'
	healthcare_encounter_write = 'healthcare_encounter_write'
	healthcare_condition_read = 'healthcare_condition_read'
	healthcare_condition_write = 'healthcare_condition_write'
	healthcare_allergy_read = 'healthcare_allergy_read'
	healthcare_allergy_write = 'healthcare_allergy_write'
	healthcare_medication_read = 'healthcare_medication_read'
	healthcare_medication_write = 'healthcare_medication_write'
	healthcare_observation_read = 'healthcare_observation_read'
	healthcare_observation_write = 'healthcare_observation_write'
	healthcare_immunization_read = 'healthcare_immunization_read'
	healthcare_immunization_write = 'healthcare_immunization_write'
	healthcare_document_read = 'healthcare_document_read'
	healthcare_document_write = 'healthcare_document_write'
	healthcare_coverage_read = 'healthcare_coverage_read'
	healthcare_coverage_write = 'healthcare_coverage_write'
	healthcare_procedure_read = 'healthcare_procedure_read'
	healthcare_procedure_write = 'healthcare_procedure_write'
	healthcare_report_read = 'healthcare_report_read'
	healthcare_report_write = 'healthcare_report_write'
	healthcare_careplan_read = 'healthcare_careplan_read'
	healthcare_careplan_write = 'healthcare_careplan_write'
	healthcare_goal_read = 'healthcare_goal_read'
	healthcare_goal_write = 'healthcare_goal_write'
	property_listing_read = 'property_listing_read'
	property_listing_write = 'property_listing_write'
	property_unittype_read = 'property_unittype_read'
	property_guest_read = 'property_guest_read'
	property_guest_write = 'property_guest_write'
	property_reservation_read = 'property_reservation_read'
	property_reservation_write = 'property_reservation_write'
	property_availability_read = 'property_availability_read'
	property_quote_read = 'property_quote_read'
	property_quote_write = 'property_quote_write'
	property_review_read = 'property_review_read'
	property_review_write = 'property_review_write'
	property_conversation_read = 'property_conversation_read'
	property_conversation_write = 'property_conversation_write'
	plm_part_read = 'plm_part_read'
	plm_part_write = 'plm_part_write'
	plm_bomline_read = 'plm_bomline_read'
	plm_bomline_write = 'plm_bomline_write'
	plm_document_read = 'plm_document_read'
	plm_document_write = 'plm_document_write'
	plm_change_read = 'plm_change_read'
	plm_change_write = 'plm_change_write'
	plm_category_read = 'plm_category_read'
	plm_category_write = 'plm_category_write'
	qms_issue_read = 'qms_issue_read'
	qms_issue_write = 'qms_issue_write'
	qms_action_read = 'qms_action_read'
	qms_action_write = 'qms_action_write'
	qms_inspection_read = 'qms_inspection_read'
	qms_inspection_write = 'qms_inspection_write'
	qms_audit_read = 'qms_audit_read'
	qms_audit_write = 'qms_audit_write'

@dataclasses.dataclass
class ConnectionCategories(str, Enum):
	passthrough = 'passthrough'
	hris = 'hris'
	ats = 'ats'
	auth = 'auth'
	saml = 'saml'
	crm = 'crm'
	enrich = 'enrich'
	martech = 'martech'
	ticketing = 'ticketing'
	uc = 'uc'
	accounting = 'accounting'
	storage = 'storage'
	commerce = 'commerce'
	payment = 'payment'
	genai = 'genai'
	messaging = 'messaging'
	kms = 'kms'
	task = 'task'
	scim = 'scim'
	lms = 'lms'
	repo = 'repo'
	metadata = 'metadata'
	calendar = 'calendar'
	verification = 'verification'
	ads = 'ads'
	analytics = 'analytics'
	forms = 'forms'
	shipping = 'shipping'
	assessment = 'assessment'
	signing = 'signing'
	clubs = 'clubs'
	datastore = 'datastore'
	cdp = 'cdp'
	performance = 'performance'
	social = 'social'
	legal = 'legal'
	compute = 'compute'
	healthcare = 'healthcare'
	property = 'property'
	plm = 'plm'
	qms = 'qms'

@dataclasses.dataclass
class PropertyConnectionAuth:
	token: Optional[str]
	access_token: Optional[str]
	refresh_token: Optional[str]
	expiry_date: Optional[str]
	expires_in: Optional[int]
	emails: Optional[PropertyConnectionEmails]
	name: Optional[str]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	app_id: Optional[str]
	client_id: Optional[str]
	client_secret: Optional[str]
	consumer_key: Optional[str]
	consumer_secret: Optional[str]
	meta: Optional[PropertyConnectionMeta]
	state: Optional[str]
	"""When integration.auth_type = "other", this field contains the authentication credentials in the same order as token_names"""
	other_auth_info: Optional[PropertyConnectionOther_auth_info]
	api_url: Optional[str]
	authorize_url: Optional[str]
	token_url: Optional[str]
	refresh_url: Optional[str]
	"""the PEM X.509 certificate in Base64 ASCII format"""
	pem: Optional[str]
	"""the private KEY X.509 certificate in Base64 ASCII format"""
	key: Optional[str]
	refresh_token_expires_in: Optional[int]
	refresh_token_expires_date: Optional[str]
	dev_api_key: Optional[str]
	audience: Optional[str]

@dataclasses.dataclass
class Connection:
	"""Unique identifier for this integration object"""
	id: Optional[str]
	"""The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(reference to KmsSpace)"""
	workspace_id: Optional[str]
	"""The integration type"""
	integration_type: str
	integration_name: Optional[str]
	"""customer's user ID"""
	external_xref: Optional[str]
	permissions: List[ConnectionPermissions]
	"""The Integration categories that this connection supports"""
	categories: List[ConnectionCategories]
	"""An authentication object that represents a specific authorized user's connection to an integration."""
	auth: Optional[PropertyConnectionAuth]
	"""Whether this integration has exceed the monthly limit of the plan"""
	is_paused: Optional[bool]
	environment: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	last_healthy_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	last_unhealthy_at: Optional[str]
	"""The HTTP status code that caused the last unhealthy status"""
	last_unhealthy_code: Optional[str]
	"""the ID of the SecretsManager object"""
	secretsmanager_id: Optional[str]
	"""the key/path/name of the secret within the vault"""
	secretsmanager_key: Optional[str]
Are we missing anything? Let us know
Was this page helpful?