Integration data model

Updated:

Informational object for supported integrations.

FieldTypeRequiredDescription
typestringYesIdentifier for this integration
created_atstringNoDate that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstringNoYYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringYesThe integration's name
is_activebooleanNoIs this integration active in this workspace
categoriesenumYesThe categories of support solutions that this integration has 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
api_docs_urlstringNoThe URL of the integration's API documentation
logo_urlstringNoThe URL of the integration's logo
in_progressbooleanNoIf this integration is not yet available as it is currently being built by unified.to
is_hiddenbooleanNo
colorstringNobutton background color for AUTH
text_colorstringNotext color for AUTH
fa_iconstringNofont-awesome icon
token_namesstring[]Noif auth_types = 'token'
token_instructionsstring[]Noinstructions for the user on how to find the token/key
web_urlstringNoURL for the software vendor
rate_limit_descriptionstringNo
betabooleanNoThis integration is new and is still considered "beta"
requires_cnamebooleanNoOAuth requires a custom API domain (CNAME) for provider verification
supportobjectNo
support.methodsmap<boolean>No
support.inbound_fieldsmap<string>No
support.outbound_fieldsmap<string>No
support.webhook_eventsIntegrationSupport_webhook_eventsNo
support.webhook_events.updatedenum[]NoValues: virtual, native
support.webhook_events.createdenum[]NoValues: virtual, native
support.webhook_events.deletedenum[]NoValues: virtual, native
support.raw_objectsstring[]Yesobjects that we map from in the integration
support.slow_fieldsstring[]No
support.from_webhookenumNoValues: supported-required, supported, not-supported
support.list_sort_by_nameenumNoValues: supported-required, supported, not-supported
support.list_sort_by_created_atenumNoValues: supported-required, supported, not-supported
support.list_sort_by_updated_atenumNoValues: supported-required, supported, not-supported
support.list_updated_gteenumNoValues: supported-required, supported, not-supported
support.list_user_idenumNoValues: supported-required, supported, not-supported
support.list_assigned_user_idenumNoValues: supported-required, supported, not-supported
support.list_user_mentioned_idenumNoValues: supported-required, supported, not-supported
support.list_customer_idenumNoValues: supported-required, supported, not-supported
support.list_company_idenumNoValues: supported-required, supported, not-supported
support.list_contact_idenumNoValues: supported-required, supported, not-supported
support.list_application_idenumNoValues: supported-required, supported, not-supported
support.list_candidate_idenumNoValues: supported-required, supported, not-supported
support.list_deal_idenumNoValues: supported-required, supported, not-supported
support.list_job_idenumNoValues: supported-required, supported, not-supported
support.list_invoice_idenumNoValues: supported-required, supported, not-supported
support.list_orderenumNoValues: supported-required, supported, not-supported
support.list_queryenumNoValues: supported-required, supported, not-supported
support.list_limitenumNoValues: supported-required, supported, not-supported
support.list_offsetenumNoValues: supported-required, supported, not-supported
support.list_root_idenumNoValues: supported-required, supported, not-supported
support.list_list_idenumNoValues: supported-required, supported, not-supported
support.list_interview_idenumNoValues: supported-required, supported, not-supported
support.list_location_idenumNoValues: supported-required, supported, not-supported
support.list_collection_idenumNoValues: supported-required, supported, not-supported
support.list_ticket_idenumNoValues: supported-required, supported, not-supported
support.list_parent_idenumNoValues: supported-required, supported, not-supported
support.list_account_idenumNoValues: supported-required, supported, not-supported
support.list_item_idenumNoValues: supported-required, supported, not-supported
support.list_space_idenumNoValues: supported-required, supported, not-supported
support.list_channel_idenumNoValues: supported-required, supported, not-supported
support.list_page_idenumNoValues: supported-required, supported, not-supported
support.list_typeenumNoValues: supported-required, supported, not-supported
support.list_link_idenumNoValues: supported-required, supported, not-supported
support.list_project_idenumNoValues: supported-required, supported, not-supported
support.list_item_variant_idenumNoValues: supported-required, supported, not-supported
support.list_raw_fieldsenumNoValues: supported-required, supported, not-supported
support.list_student_idenumNoValues: supported-required, supported, not-supported
support.list_class_idenumNoValues: supported-required, supported, not-supported
support.list_instructor_idenumNoValues: supported-required, supported, not-supported
support.list_course_idenumNoValues: supported-required, supported, not-supported
support.list_teacher_idenumNoValues: supported-required, supported, not-supported
support.list_repo_idenumNoValues: supported-required, supported, not-supported
support.list_org_idenumNoValues: supported-required, supported, not-supported
support.list_calendar_idenumNoValues: supported-required, supported, not-supported
support.list_task_idenumNoValues: supported-required, supported, not-supported
support.list_agent_idenumNoValues: supported-required, supported, not-supported
support.search_twitterenumNoValues: supported-required, supported, not-supported
support.search_nameenumNoValues: supported-required, supported, not-supported
support.search_linkedinurlenumNoValues: supported-required, supported, not-supported
support.search_emailenumNoValues: supported-required, supported, not-supported
support.search_domainenumNoValues: supported-required, supported, not-supported
support.list_event_idenumNoValues: supported-required, supported, not-supported
support.list_start_gteenumNoValues: supported-required, supported, not-supported
support.list_end_ltenumNoValues: supported-required, supported, not-supported
support.list_lead_idenumNoValues: supported-required, supported, not-supported
support.list_call_idenumNoValues: supported-required, supported, not-supported
support.list_document_idenumNoValues: supported-required, supported, not-supported
support.list_payment_idenumNoValues: supported-required, supported, not-supported
support.list_statusenumNoValues: supported-required, supported, not-supported
support.list_branch_idenumNoValues: supported-required, supported, not-supported
support.list_pipeline_idenumNoValues: supported-required, supported, not-supported
support.list_category_idenumNoValues: supported-required, supported, not-supported
support.list_package_idenumNoValues: supported-required, supported, not-supported
support.list_expandenumNoValues: supported-required, supported, not-supported
support.native_webhook_parent_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_project_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_company_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_task_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_channel_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_calendar_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_event_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_updated_gteenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_limitenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_channel_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_parent_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_contact_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_deal_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_company_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_user_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_user_mentioned_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_typeenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_ticket_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_expandenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_statusenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_start_gteenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_end_ltenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_task_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_space_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_repo_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_project_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_pipeline_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_page_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_org_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_location_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_list_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_job_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_item_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_fieldsenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_event_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_customer_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_collection_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_candidate_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_call_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_branch_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_application_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_item_variant_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_calendar_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_lead_idenumNoValues: supported-required, supported, not-supported
support.list_payslip_idenumNoValues: supported-required, supported, not-supported
support.list_benefit_idenumNoValues: supported-required, supported, not-supported
support.list_saleschannel_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_saleschannel_idenumNoValues: supported-required, supported, not-supported
support.list_campaign_idenumNoValues: supported-required, supported, not-supported
support.list_ad_idenumNoValues: supported-required, supported, not-supported
support.list_group_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_campaign_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_ad_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_group_idenumNoValues: supported-required, supported, not-supported
support.list_form_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_form_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_form_idenumNoValues: supported-required, supported, not-supported
support.list_order_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_order_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_order_idenumNoValues: supported-required, supported, not-supported
support.list_carrier_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_carrier_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_carrier_idenumNoValues: supported-required, supported, not-supported
support.list_shipment_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_shipment_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_shipment_idenumNoValues: supported-required, supported, not-supported
support.list_label_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_label_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_label_idenumNoValues: supported-required, supported, not-supported
support.list_member_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_member_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_member_idenumNoValues: supported-required, supported, not-supported
support.list_content_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_course_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_course_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_student_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_student_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_typeenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_link_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_bill_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_invoice_idenumNoValues: supported-required, supported, not-supported
support.list_bill_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_benefit_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_payment_idenumNoValues: supported-required, supported, not-supported
support.list_fulltextenumNoValues: supported-required, supported, not-supported
support.list_io_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_io_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_io_idenumNoValues: supported-required, supported, not-supported
support.list_sizeenumNoValues: supported-required, supported, not-supported
support.list_template_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_template_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_template_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_list_idenumNoValues: supported-required, supported, not-supported
support.list_referenceenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_referenceenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_account_idenumNoValues: supported-required, supported, not-supported
support.list_database_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_database_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_database_idenumNoValues: supported-required, supported, not-supported
support.list_table_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_table_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_table_idenumNoValues: supported-required, supported, not-supported
support.list_property_idenumNoValues: supported-required, supported, not-supported
support.list_visitor_idenumNoValues: supported-required, supported, not-supported
support.list_session_idenumNoValues: supported-required, supported, not-supported
support.list_profile_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_property_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_property_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_session_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_session_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_visitor_idenumNoValues: supported-required, supported, not-supported
support.native_webhook_visitor_idenumNoValues: supported-required, supported, not-supported
support.list_mediumenumNoValues: supported-required, supported, not-supported
support.list_sourceenumNoValues: supported-required, supported, not-supported
support.list_dimensionenumNoValues: supported-required, supported, not-supported
support.list_goalenumNoValues: supported-required, supported, not-supported
support.list_role_idenumNoValues: supported-required, supported, not-supported
support.list_effective_statusenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_assigned_user_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_profile_idenumNoValues: supported-required, supported, not-supported
support.list_segment_idenumNoValues: supported-required, supported, not-supported
support.list_cycle_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_cycle_idenumNoValues: supported-required, supported, not-supported
support.list_bankfeedaccount_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_bankfeedaccount_idenumNoValues: supported-required, supported, not-supported
support.list_post_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_post_idenumNoValues: supported-required, supported, not-supported
support.list_approver_user_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_approver_user_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_effective_statusenumNoValues: supported-required, supported, not-supported
support.native_webhook_updated_gteenumNoValues: supported-required, supported, not-supported
support.list_destination_idenumNoValues: supported-required, supported, not-supported
support.list_emailenumNoValues: supported-required, supported, not-supported
support.list_matter_idenumNoValues: supported-required, supported, not-supported
support.list_room_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_matter_idenumNoValues: supported-required, supported, not-supported
support.list_practicearea_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_practicearea_idenumNoValues: supported-required, supported, not-supported
support.list_region_idenumNoValues: supported-required, supported, not-supported
support.list_instance_idenumNoValues: supported-required, supported, not-supported
support.list_service_idenumNoValues: supported-required, supported, not-supported
support.list_patient_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_patient_idenumNoValues: supported-required, supported, not-supported
support.list_practitioner_idenumNoValues: supported-required, supported, not-supported
support.virtual_webhook_practitioner_idenumNoValues: supported-required, supported, not-supported
tested_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sandboxobjectNo
partnershipobjectNo
samlobjectNo
descriptionstringNo
apiobjectNo
featuredbooleanNo
popularitynumberNo
active_healthy_connectionsnumberNo

TypeScript

TypeScript
export type Integration = {
	type: string; // Identifier for this integration
	created_at?: string; // Date that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string; // YYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name: string; // The integration's name
	is_active?: boolean; // Is this integration active in this workspace
	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' )[]; // The categories of support solutions that this integration has
	api_docs_url?: string; // The URL of the integration's API documentation
	logo_url?: string; // The URL of the integration's logo
	in_progress?: boolean; // If this integration is not yet available as it is currently being built by unified.to
	is_hidden?: boolean;
	color?: string; // button background color for AUTH
	text_color?: string; // text color for AUTH
	fa_icon?: string; // font-awesome icon
	token_names?: string[]; // if auth_types = 'token'
	token_instructions?: string[]; // instructions for the user on how to find the token/key
	web_url?: string; // URL for the software vendor
	rate_limit_description?: string;
	beta?: boolean; // This integration is new and is still considered "beta"
	requires_cname?: boolean; // OAuth requires a custom API domain (CNAME) for provider verification
	support?: Record <string, { 
		methods?: any;
		inbound_fields?: any;
		outbound_fields?: any;
		webhook_events?: any;
		raw_objects: any; // objects that we map from in the integration
		slow_fields?: any;
		from_webhook?: 'supported-required' | 'supported' | 'not-supported';
		list_sort_by_name?: 'supported-required' | 'supported' | 'not-supported';
		list_sort_by_created_at?: 'supported-required' | 'supported' | 'not-supported';
		list_sort_by_updated_at?: 'supported-required' | 'supported' | 'not-supported';
		list_updated_gte?: 'supported-required' | 'supported' | 'not-supported';
		list_user_id?: 'supported-required' | 'supported' | 'not-supported';
		list_assigned_user_id?: 'supported-required' | 'supported' | 'not-supported';
		list_user_mentioned_id?: 'supported-required' | 'supported' | 'not-supported';
		list_customer_id?: 'supported-required' | 'supported' | 'not-supported';
		list_company_id?: 'supported-required' | 'supported' | 'not-supported';
		list_contact_id?: 'supported-required' | 'supported' | 'not-supported';
		list_application_id?: 'supported-required' | 'supported' | 'not-supported';
		list_candidate_id?: 'supported-required' | 'supported' | 'not-supported';
		list_deal_id?: 'supported-required' | 'supported' | 'not-supported';
		list_job_id?: 'supported-required' | 'supported' | 'not-supported';
		list_invoice_id?: 'supported-required' | 'supported' | 'not-supported';
		list_order?: 'supported-required' | 'supported' | 'not-supported';
		list_query?: 'supported-required' | 'supported' | 'not-supported';
		list_limit?: 'supported-required' | 'supported' | 'not-supported';
		list_offset?: 'supported-required' | 'supported' | 'not-supported';
		list_root_id?: 'supported-required' | 'supported' | 'not-supported';
		list_list_id?: 'supported-required' | 'supported' | 'not-supported';
		list_interview_id?: 'supported-required' | 'supported' | 'not-supported';
		list_location_id?: 'supported-required' | 'supported' | 'not-supported';
		list_collection_id?: 'supported-required' | 'supported' | 'not-supported';
		list_ticket_id?: 'supported-required' | 'supported' | 'not-supported';
		list_parent_id?: 'supported-required' | 'supported' | 'not-supported';
		list_account_id?: 'supported-required' | 'supported' | 'not-supported';
		list_item_id?: 'supported-required' | 'supported' | 'not-supported';
		list_space_id?: 'supported-required' | 'supported' | 'not-supported';
		list_channel_id?: 'supported-required' | 'supported' | 'not-supported';
		list_page_id?: 'supported-required' | 'supported' | 'not-supported';
		list_type?: 'supported-required' | 'supported' | 'not-supported';
		list_link_id?: 'supported-required' | 'supported' | 'not-supported';
		list_project_id?: 'supported-required' | 'supported' | 'not-supported';
		list_item_variant_id?: 'supported-required' | 'supported' | 'not-supported';
		list_raw_fields?: 'supported-required' | 'supported' | 'not-supported';
		list_student_id?: 'supported-required' | 'supported' | 'not-supported';
		list_class_id?: 'supported-required' | 'supported' | 'not-supported';
		list_instructor_id?: 'supported-required' | 'supported' | 'not-supported';
		list_course_id?: 'supported-required' | 'supported' | 'not-supported';
		list_teacher_id?: 'supported-required' | 'supported' | 'not-supported';
		list_repo_id?: 'supported-required' | 'supported' | 'not-supported';
		list_org_id?: 'supported-required' | 'supported' | 'not-supported';
		list_calendar_id?: 'supported-required' | 'supported' | 'not-supported';
		list_task_id?: 'supported-required' | 'supported' | 'not-supported';
		list_agent_id?: 'supported-required' | 'supported' | 'not-supported';
		search_twitter?: 'supported-required' | 'supported' | 'not-supported';
		search_name?: 'supported-required' | 'supported' | 'not-supported';
		search_linkedinurl?: 'supported-required' | 'supported' | 'not-supported';
		search_email?: 'supported-required' | 'supported' | 'not-supported';
		search_domain?: 'supported-required' | 'supported' | 'not-supported';
		list_event_id?: 'supported-required' | 'supported' | 'not-supported';
		list_start_gte?: 'supported-required' | 'supported' | 'not-supported';
		list_end_lt?: 'supported-required' | 'supported' | 'not-supported';
		list_lead_id?: 'supported-required' | 'supported' | 'not-supported';
		list_call_id?: 'supported-required' | 'supported' | 'not-supported';
		list_document_id?: 'supported-required' | 'supported' | 'not-supported';
		list_payment_id?: 'supported-required' | 'supported' | 'not-supported';
		list_status?: 'supported-required' | 'supported' | 'not-supported';
		list_branch_id?: 'supported-required' | 'supported' | 'not-supported';
		list_pipeline_id?: 'supported-required' | 'supported' | 'not-supported';
		list_category_id?: 'supported-required' | 'supported' | 'not-supported';
		list_package_id?: 'supported-required' | 'supported' | 'not-supported';
		list_expand?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_parent_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_project_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_company_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_task_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_channel_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_calendar_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_event_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_updated_gte?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_limit?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_channel_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_parent_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_contact_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_deal_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_company_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_user_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_user_mentioned_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_type?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_ticket_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_expand?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_status?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_start_gte?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_end_lt?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_task_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_space_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_repo_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_project_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_pipeline_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_page_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_org_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_location_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_list_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_job_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_item_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_fields?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_event_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_customer_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_collection_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_candidate_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_call_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_branch_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_application_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_item_variant_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_calendar_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_lead_id?: 'supported-required' | 'supported' | 'not-supported';
		list_payslip_id?: 'supported-required' | 'supported' | 'not-supported';
		list_benefit_id?: 'supported-required' | 'supported' | 'not-supported';
		list_saleschannel_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_saleschannel_id?: 'supported-required' | 'supported' | 'not-supported';
		list_campaign_id?: 'supported-required' | 'supported' | 'not-supported';
		list_ad_id?: 'supported-required' | 'supported' | 'not-supported';
		list_group_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_campaign_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_ad_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_group_id?: 'supported-required' | 'supported' | 'not-supported';
		list_form_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_form_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_form_id?: 'supported-required' | 'supported' | 'not-supported';
		list_order_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_order_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_order_id?: 'supported-required' | 'supported' | 'not-supported';
		list_carrier_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_carrier_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_carrier_id?: 'supported-required' | 'supported' | 'not-supported';
		list_shipment_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_shipment_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_shipment_id?: 'supported-required' | 'supported' | 'not-supported';
		list_label_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_label_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_label_id?: 'supported-required' | 'supported' | 'not-supported';
		list_member_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_member_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_member_id?: 'supported-required' | 'supported' | 'not-supported';
		list_content_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_course_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_course_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_student_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_student_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_type?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_link_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_bill_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_invoice_id?: 'supported-required' | 'supported' | 'not-supported';
		list_bill_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_benefit_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_payment_id?: 'supported-required' | 'supported' | 'not-supported';
		list_fulltext?: 'supported-required' | 'supported' | 'not-supported';
		list_io_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_io_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_io_id?: 'supported-required' | 'supported' | 'not-supported';
		list_size?: 'supported-required' | 'supported' | 'not-supported';
		list_template_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_template_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_template_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_list_id?: 'supported-required' | 'supported' | 'not-supported';
		list_reference?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_reference?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_account_id?: 'supported-required' | 'supported' | 'not-supported';
		list_database_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_database_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_database_id?: 'supported-required' | 'supported' | 'not-supported';
		list_table_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_table_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_table_id?: 'supported-required' | 'supported' | 'not-supported';
		list_property_id?: 'supported-required' | 'supported' | 'not-supported';
		list_visitor_id?: 'supported-required' | 'supported' | 'not-supported';
		list_session_id?: 'supported-required' | 'supported' | 'not-supported';
		list_profile_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_property_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_property_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_session_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_session_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_visitor_id?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_visitor_id?: 'supported-required' | 'supported' | 'not-supported';
		list_medium?: 'supported-required' | 'supported' | 'not-supported';
		list_source?: 'supported-required' | 'supported' | 'not-supported';
		list_dimension?: 'supported-required' | 'supported' | 'not-supported';
		list_goal?: 'supported-required' | 'supported' | 'not-supported';
		list_role_id?: 'supported-required' | 'supported' | 'not-supported';
		list_effective_status?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_assigned_user_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_profile_id?: 'supported-required' | 'supported' | 'not-supported';
		list_segment_id?: 'supported-required' | 'supported' | 'not-supported';
		list_cycle_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_cycle_id?: 'supported-required' | 'supported' | 'not-supported';
		list_bankfeedaccount_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_bankfeedaccount_id?: 'supported-required' | 'supported' | 'not-supported';
		list_post_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_post_id?: 'supported-required' | 'supported' | 'not-supported';
		list_approver_user_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_approver_user_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_effective_status?: 'supported-required' | 'supported' | 'not-supported';
		native_webhook_updated_gte?: 'supported-required' | 'supported' | 'not-supported';
		list_destination_id?: 'supported-required' | 'supported' | 'not-supported';
		list_email?: 'supported-required' | 'supported' | 'not-supported';
		list_matter_id?: 'supported-required' | 'supported' | 'not-supported';
		list_room_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_matter_id?: 'supported-required' | 'supported' | 'not-supported';
		list_practicearea_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_practicearea_id?: 'supported-required' | 'supported' | 'not-supported';
		list_region_id?: 'supported-required' | 'supported' | 'not-supported';
		list_instance_id?: 'supported-required' | 'supported' | 'not-supported';
		list_service_id?: 'supported-required' | 'supported' | 'not-supported';
		list_patient_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_patient_id?: 'supported-required' | 'supported' | 'not-supported';
		list_practitioner_id?: 'supported-required' | 'supported' | 'not-supported';
		virtual_webhook_practitioner_id?: 'supported-required' | 'supported' | 'not-supported'; 
	}> ;
	tested_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	sandbox?: any;
	partnership?: any;
	saml?: any;
	description?: string;
	api?: any;
	featured?: boolean;
	popularity?: number;
	active_healthy_connections?: number;
} 

Zod

Zod
import { z } from 'zod';

export const ZodIntegration = z.object({
	type: z.string().describe("Identifier for this integration"),
	created_at: z.string().optional().describe("Date that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string().optional().describe("YYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().describe("The integration's name"),
	is_active: z.boolean().optional().describe("Is this integration active in this workspace"),
	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' ).describe("The categories of support solutions that this integration has"),
	api_docs_url: z.string().optional().describe("The URL of the integration's API documentation"),
	logo_url: z.string().optional().describe("The URL of the integration's logo"),
	in_progress: z.boolean().optional().describe("If this integration is not yet available as it is currently being built by unified.to"),
	is_hidden: z.boolean().optional(),
	color: z.string().optional().describe("button background color for AUTH"),
	text_color: z.string().optional().describe("text color for AUTH"),
	fa_icon: z.string().optional().describe("font-awesome icon"),
	token_names: z.array().optional().describe("if auth_types = 'token'"),
	token_instructions: z.array().optional().describe("instructions for the user on how to find the token/key"),
	web_url: z.string().optional().describe("URL for the software vendor"),
	rate_limit_description: z.string().optional(),
	beta: z.boolean().optional().describe("This integration is new and is still considered "beta""),
	requires_cname: z.boolean().optional().describe("OAuth requires a custom API domain (CNAME) for provider verification"),
	support: z.record(z.string(), z.object({ 
			methods: z.unknown().optional(),
			inbound_fields: z.unknown().optional(),
			outbound_fields: z.unknown().optional(),
			webhook_events: z.unknown().optional(),
			raw_objects: z.unknown().describe("objects that we map from in the integration"),
			slow_fields: z.unknown().optional(),
			from_webhook: z.enum("supported-required", "supported", "not-supported").optional(),
			list_sort_by_name: z.enum("supported-required", "supported", "not-supported").optional(),
			list_sort_by_created_at: z.enum("supported-required", "supported", "not-supported").optional(),
			list_sort_by_updated_at: z.enum("supported-required", "supported", "not-supported").optional(),
			list_updated_gte: z.enum("supported-required", "supported", "not-supported").optional(),
			list_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_assigned_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_user_mentioned_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_customer_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_company_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_contact_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_application_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_candidate_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_deal_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_job_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_invoice_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_order: z.enum("supported-required", "supported", "not-supported").optional(),
			list_query: z.enum("supported-required", "supported", "not-supported").optional(),
			list_limit: z.enum("supported-required", "supported", "not-supported").optional(),
			list_offset: z.enum("supported-required", "supported", "not-supported").optional(),
			list_root_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_list_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_interview_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_location_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_collection_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_ticket_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_parent_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_account_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_item_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_space_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_channel_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_page_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_type: z.enum("supported-required", "supported", "not-supported").optional(),
			list_link_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_project_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_item_variant_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_raw_fields: z.enum("supported-required", "supported", "not-supported").optional(),
			list_student_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_class_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_instructor_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_course_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_teacher_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_repo_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_org_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_calendar_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_task_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_agent_id: z.enum("supported-required", "supported", "not-supported").optional(),
			search_twitter: z.enum("supported-required", "supported", "not-supported").optional(),
			search_name: z.enum("supported-required", "supported", "not-supported").optional(),
			search_linkedinurl: z.enum("supported-required", "supported", "not-supported").optional(),
			search_email: z.enum("supported-required", "supported", "not-supported").optional(),
			search_domain: z.enum("supported-required", "supported", "not-supported").optional(),
			list_event_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_start_gte: z.enum("supported-required", "supported", "not-supported").optional(),
			list_end_lt: z.enum("supported-required", "supported", "not-supported").optional(),
			list_lead_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_call_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_document_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_payment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_status: z.enum("supported-required", "supported", "not-supported").optional(),
			list_branch_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_pipeline_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_category_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_package_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_expand: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_parent_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_project_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_company_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_task_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_channel_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_calendar_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_event_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_updated_gte: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_limit: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_channel_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_parent_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_contact_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_deal_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_company_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_user_mentioned_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_type: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_ticket_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_expand: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_status: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_start_gte: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_end_lt: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_task_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_space_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_repo_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_project_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_pipeline_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_page_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_org_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_location_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_list_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_job_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_item_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_fields: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_event_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_customer_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_collection_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_candidate_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_call_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_branch_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_application_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_item_variant_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_calendar_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_lead_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_payslip_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_benefit_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_saleschannel_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_saleschannel_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_campaign_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_ad_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_group_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_campaign_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_ad_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_group_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_form_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_form_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_form_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_order_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_order_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_order_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_carrier_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_carrier_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_carrier_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_shipment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_shipment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_shipment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_label_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_label_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_label_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_member_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_member_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_member_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_content_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_course_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_course_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_student_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_student_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_type: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_link_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_bill_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_invoice_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_bill_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_benefit_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_payment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_fulltext: z.enum("supported-required", "supported", "not-supported").optional(),
			list_io_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_io_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_io_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_size: z.enum("supported-required", "supported", "not-supported").optional(),
			list_template_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_template_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_template_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_list_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_reference: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_reference: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_account_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_database_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_database_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_database_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_table_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_table_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_table_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_property_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_visitor_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_session_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_profile_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_property_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_property_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_session_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_session_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_visitor_id: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_visitor_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_medium: z.enum("supported-required", "supported", "not-supported").optional(),
			list_source: z.enum("supported-required", "supported", "not-supported").optional(),
			list_dimension: z.enum("supported-required", "supported", "not-supported").optional(),
			list_goal: z.enum("supported-required", "supported", "not-supported").optional(),
			list_role_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_effective_status: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_assigned_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_profile_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_segment_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_cycle_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_cycle_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_bankfeedaccount_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_bankfeedaccount_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_post_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_post_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_approver_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_approver_user_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_effective_status: z.enum("supported-required", "supported", "not-supported").optional(),
			native_webhook_updated_gte: z.enum("supported-required", "supported", "not-supported").optional(),
			list_destination_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_email: z.enum("supported-required", "supported", "not-supported").optional(),
			list_matter_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_room_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_matter_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_practicearea_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_practicearea_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_region_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_instance_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_service_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_patient_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_patient_id: z.enum("supported-required", "supported", "not-supported").optional(),
			list_practitioner_id: z.enum("supported-required", "supported", "not-supported").optional(),
			virtual_webhook_practitioner_id: z.enum("supported-required", "supported", "not-supported").optional()
})).optional(),
	tested_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	sandbox: z.unknown().optional(),
	partnership: z.unknown().optional(),
	saml: z.unknown().optional(),
	description: z.string().optional(),
	api: z.unknown().optional(),
	featured: z.boolean().optional(),
	popularity: z.number().optional(),
	active_healthy_connections: z.number().optional()
});

Python

Python
import dataclasses

@dataclasses.dataclass
class IntegrationCategories(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'

@dataclasses.dataclass
class Integration:
	"""Identifier for this integration"""
	type: str
	"""Date that this integration was supported (YYYY-MM-DD) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""YYYY-MM-DD (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The integration's name"""
	name: str
	"""Is this integration active in this workspace"""
	is_active: Optional[bool]
	"""The categories of support solutions that this integration has"""
	categories: List[IntegrationCategories]
	"""The URL of the integration's API documentation"""
	api_docs_url: Optional[str]
	"""The URL of the integration's logo"""
	logo_url: Optional[str]
	"""If this integration is not yet available as it is currently being built by unified.to"""
	in_progress: Optional[bool]
	is_hidden: Optional[bool]
	"""button background color for AUTH"""
	color: Optional[str]
	"""text color for AUTH"""
	text_color: Optional[str]
	"""font-awesome icon"""
	fa_icon: Optional[str]
	"""if auth_types = 'token'"""
	token_names: Optional[List[List[str]]]
	"""instructions for the user on how to find the token/key"""
	token_instructions: Optional[List[List[str]]]
	"""URL for the software vendor"""
	web_url: Optional[str]
	rate_limit_description: Optional[str]
	"""This integration is new and is still considered "beta""""
	beta: Optional[bool]
	"""OAuth requires a custom API domain (CNAME) for provider verification"""
	requires_cname: Optional[bool]
	support: Optional[PropertyIntegrationSupport]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	tested_at: Optional[str]
	sandbox: Optional[PropertyIntegrationSandbox]
	partnership: Optional[PropertyIntegrationPartnership]
	saml: Optional[PropertyIntegrationSaml]
	description: Optional[str]
	api: Optional[PropertyIntegrationApi]
	featured: Optional[bool]
	popularity: Optional[int]
	active_healthy_connections: Optional[int]
Are we missing anything? Let us know
Was this page helpful?