Create workspace integration

Updated:

POST/unified/workspaceintegration

Payload

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring
(reference to KmsSpace)
integration_typestring required
is_activeboolean required
api_urlstring
authorize_urlstring
token_urlstring
refresh_urlstring
base_urlstring
prompt_regionboolean
use_unified_redirectboolean
auth_type enum
Valid values:
"oauth2"
"other"
"token"
the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)
environmentstring
authentication environment
categories enum array
Valid values:
"passthrough"
"hris"
"ats"
"auth"
"saml"
derived from permissions (plus the auth, passthrough and saml categories, which have no permissions)
permissions enum array
Valid values:
"accounting_account_read"
"accounting_account_write"
"accounting_transaction_read"
"accounting_transaction_write"
"accounting_journal_read"
the unified permission scopes enabled for this integration; requested when an authorization URL omits scopes
overriden_scopesobject
success_redirectstring
Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by /oauth/code/{workspace}/{env}/{integration}.
failure_redirectstring
Post-OAuth failure URL for marketplace installs. Used by /oauth/code/{workspace}/{env}/{integration}.
authobject
secretsmanager_idstring
the ID of the SecretsManager object
secretsmanager_keystring
the key/path/name of the secret within the vault

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstringNo(reference to KmsSpace)
integration_typestringYes
is_activebooleanYes
api_urlstringNo
authorize_urlstringNo
token_urlstringNo
refresh_urlstringNo
base_urlstringNo
prompt_regionbooleanNo
use_unified_redirectbooleanNo
auth_typeenumNothe authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist) Values: oauth2, other, token
environmentstringNoauthentication environment
categoriesenumNoderived from permissions (plus the auth, passthrough and saml categories, which have no permissions) 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
permissionsenumNothe unified permission scopes enabled for this integration; requested when an authorization URL omits scopes Values: 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, 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, 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
overriden_scopesobjectNo
overriden_scopes.accounting_account_readstringNo
overriden_scopes.accounting_account_writestringNo
overriden_scopes.accounting_transaction_readstringNo
overriden_scopes.accounting_transaction_writestringNo
overriden_scopes.accounting_journal_readstringNo
overriden_scopes.accounting_journal_writestringNo
overriden_scopes.accounting_invoice_readstringNo
overriden_scopes.accounting_invoice_writestringNo
overriden_scopes.accounting_bill_readstringNo
overriden_scopes.accounting_bill_writestringNo
overriden_scopes.accounting_vendorcredit_readstringNo
overriden_scopes.accounting_vendorcredit_writestringNo
overriden_scopes.accounting_creditmemo_readstringNo
overriden_scopes.accounting_creditmemo_writestringNo
overriden_scopes.accounting_contact_readstringNo
overriden_scopes.accounting_contact_writestringNo
overriden_scopes.accounting_expense_readstringNo
overriden_scopes.accounting_expense_writestringNo
overriden_scopes.accounting_expensereport_readstringNo
overriden_scopes.accounting_expensereport_writestringNo
overriden_scopes.accounting_purchasereceipt_readstringNo
overriden_scopes.accounting_purchasereceipt_writestringNo
overriden_scopes.accounting_taxrate_readstringNo
overriden_scopes.accounting_taxrate_writestringNo
overriden_scopes.accounting_paymentterm_readstringNo
overriden_scopes.accounting_paymentterm_writestringNo
overriden_scopes.accounting_organization_readstringNo
overriden_scopes.accounting_order_readstringNo
overriden_scopes.accounting_order_writestringNo
overriden_scopes.accounting_purchaseorder_readstringNo
overriden_scopes.accounting_purchaseorder_writestringNo
overriden_scopes.accounting_salesorder_readstringNo
overriden_scopes.accounting_salesorder_writestringNo
overriden_scopes.accounting_salesreceipt_readstringNo
overriden_scopes.accounting_salesreceipt_writestringNo
overriden_scopes.accounting_trialbalance_readstringNo
overriden_scopes.accounting_trialbalance_writestringNo
overriden_scopes.accounting_profitloss_readstringNo
overriden_scopes.accounting_profitloss_writestringNo
overriden_scopes.accounting_balancesheet_readstringNo
overriden_scopes.accounting_balancesheet_writestringNo
overriden_scopes.accounting_category_readstringNo
overriden_scopes.accounting_category_writestringNo
overriden_scopes.payment_payment_readstringNo
overriden_scopes.payment_payment_writestringNo
overriden_scopes.accounting_cashflow_readstringNo
overriden_scopes.accounting_cashflow_writestringNo
overriden_scopes.accounting_quote_readstringNo
overriden_scopes.accounting_quote_writestringNo
overriden_scopes.accounting_agedreceivable_readstringNo
overriden_scopes.accounting_agedpayable_readstringNo
overriden_scopes.accounting_project_readstringNo
overriden_scopes.accounting_project_writestringNo
overriden_scopes.accounting_bankfeedaccount_readstringNo
overriden_scopes.accounting_bankfeedaccount_writestringNo
overriden_scopes.accounting_bankfeedtransaction_readstringNo
overriden_scopes.accounting_bankfeedtransaction_writestringNo
overriden_scopes.payment_payout_readstringNo
overriden_scopes.payment_refund_readstringNo
overriden_scopes.payment_link_readstringNo
overriden_scopes.payment_link_writestringNo
overriden_scopes.payment_subscription_readstringNo
overriden_scopes.payment_subscription_writestringNo
overriden_scopes.commerce_item_readstringNo
overriden_scopes.commerce_item_writestringNo
overriden_scopes.commerce_collection_readstringNo
overriden_scopes.commerce_collection_writestringNo
overriden_scopes.commerce_inventory_readstringNo
overriden_scopes.commerce_inventory_writestringNo
overriden_scopes.commerce_location_readstringNo
overriden_scopes.commerce_location_writestringNo
overriden_scopes.commerce_review_readstringNo
overriden_scopes.commerce_review_writestringNo
overriden_scopes.commerce_saleschannel_readstringNo
overriden_scopes.commerce_saleschannel_writestringNo
overriden_scopes.commerce_itemvariant_readstringNo
overriden_scopes.commerce_itemvariant_writestringNo
overriden_scopes.commerce_reservation_readstringNo
overriden_scopes.commerce_reservation_writestringNo
overriden_scopes.commerce_table_readstringNo
overriden_scopes.commerce_table_writestringNo
overriden_scopes.commerce_return_readstringNo
overriden_scopes.commerce_return_writestringNo
overriden_scopes.commerce_availability_readstringNo
overriden_scopes.commerce_availability_writestringNo
overriden_scopes.verification_package_readstringNo
overriden_scopes.verification_request_readstringNo
overriden_scopes.verification_request_writestringNo
overriden_scopes.assessment_package_readstringNo
overriden_scopes.assessment_package_writestringNo
overriden_scopes.assessment_order_writestringNo
overriden_scopes.ats_activity_readstringNo
overriden_scopes.ats_activity_writestringNo
overriden_scopes.ats_application_readstringNo
overriden_scopes.ats_application_writestringNo
overriden_scopes.ats_applicationstatus_readstringNo
overriden_scopes.ats_candidate_readstringNo
overriden_scopes.ats_candidate_writestringNo
overriden_scopes.ats_interview_readstringNo
overriden_scopes.ats_interview_writestringNo
overriden_scopes.ats_job_readstringNo
overriden_scopes.ats_job_writestringNo
overriden_scopes.ats_company_readstringNo
overriden_scopes.ats_company_writestringNo
overriden_scopes.ats_document_readstringNo
overriden_scopes.ats_document_writestringNo
overriden_scopes.ats_scorecard_readstringNo
overriden_scopes.ats_scorecard_writestringNo
overriden_scopes.crm_company_readstringNo
overriden_scopes.crm_company_writestringNo
overriden_scopes.crm_contact_readstringNo
overriden_scopes.crm_contact_writestringNo
overriden_scopes.crm_deal_readstringNo
overriden_scopes.crm_deal_writestringNo
overriden_scopes.crm_event_readstringNo
overriden_scopes.crm_event_writestringNo
overriden_scopes.crm_lead_readstringNo
overriden_scopes.crm_lead_writestringNo
overriden_scopes.crm_pipeline_readstringNo
overriden_scopes.crm_pipeline_writestringNo
overriden_scopes.crm_taxonomy_readstringNo
overriden_scopes.martech_list_readstringNo
overriden_scopes.martech_list_writestringNo
overriden_scopes.martech_member_readstringNo
overriden_scopes.martech_member_writestringNo
overriden_scopes.martech_campaign_readstringNo
overriden_scopes.martech_campaign_writestringNo
overriden_scopes.martech_report_readstringNo
overriden_scopes.martech_report_writestringNo
overriden_scopes.ticketing_customer_readstringNo
overriden_scopes.ticketing_customer_writestringNo
overriden_scopes.ticketing_ticket_readstringNo
overriden_scopes.ticketing_ticket_writestringNo
overriden_scopes.ticketing_note_readstringNo
overriden_scopes.ticketing_note_writestringNo
overriden_scopes.ticketing_category_readstringNo
overriden_scopes.ticketing_category_writestringNo
overriden_scopes.hris_employee_readstringNo
overriden_scopes.hris_employee_writestringNo
overriden_scopes.hris_group_readstringNo
overriden_scopes.hris_group_writestringNo
overriden_scopes.hris_payslip_readstringNo
overriden_scopes.hris_payslip_writestringNo
overriden_scopes.hris_timeoff_readstringNo
overriden_scopes.hris_timeoff_writestringNo
overriden_scopes.hris_timeshift_readstringNo
overriden_scopes.hris_timeshift_writestringNo
overriden_scopes.hris_attendance_readstringNo
overriden_scopes.hris_attendance_writestringNo
overriden_scopes.hris_company_readstringNo
overriden_scopes.hris_company_writestringNo
overriden_scopes.hris_location_readstringNo
overriden_scopes.hris_location_writestringNo
overriden_scopes.hris_device_readstringNo
overriden_scopes.hris_device_writestringNo
overriden_scopes.hris_deduction_readstringNo
overriden_scopes.hris_deduction_writestringNo
overriden_scopes.hris_benefit_readstringNo
overriden_scopes.hris_benefit_writestringNo
overriden_scopes.hris_bankaccount_readstringNo
overriden_scopes.hris_bankaccount_writestringNo
overriden_scopes.hris_document_readstringNo
overriden_scopes.hris_document_writestringNo
overriden_scopes.hris_taxonomy_readstringNo
overriden_scopes.hris_taxonomy_writestringNo
overriden_scopes.hris_job_readstringNo
overriden_scopes.hris_job_writestringNo
overriden_scopes.hris_payroll_readstringNo
overriden_scopes.hris_payroll_writestringNo
overriden_scopes.hris_paycode_readstringNo
overriden_scopes.hris_paycode_writestringNo
overriden_scopes.hris_earning_readstringNo
overriden_scopes.hris_earning_writestringNo
overriden_scopes.uc_call_readstringNo
overriden_scopes.uc_call_writestringNo
overriden_scopes.uc_contact_readstringNo
overriden_scopes.uc_contact_writestringNo
overriden_scopes.uc_fax_readstringNo
overriden_scopes.uc_fax_writestringNo
overriden_scopes.uc_comment_readstringNo
overriden_scopes.uc_comment_writestringNo
overriden_scopes.uc_recording_readstringNo
overriden_scopes.uc_scorecard_readstringNo
overriden_scopes.uc_scorecardtemplate_readstringNo
overriden_scopes.storage_file_readstringNo
overriden_scopes.storage_file_writestringNo
overriden_scopes.webhookstringNo
overriden_scopes.genai_model_readstringNo
overriden_scopes.genai_prompt_readstringNo
overriden_scopes.genai_prompt_writestringNo
overriden_scopes.genai_embedding_readstringNo
overriden_scopes.genai_embedding_writestringNo
overriden_scopes.genai_task_readstringNo
overriden_scopes.genai_task_writestringNo
overriden_scopes.genai_agent_readstringNo
overriden_scopes.genai_agent_writestringNo
overriden_scopes.genai_organization_readstringNo
overriden_scopes.genai_organization_writestringNo
overriden_scopes.genai_skill_readstringNo
overriden_scopes.genai_skill_writestringNo
overriden_scopes.genai_memory_readstringNo
overriden_scopes.genai_memory_writestringNo
overriden_scopes.messaging_message_readstringNo
overriden_scopes.messaging_message_writestringNo
overriden_scopes.messaging_channel_readstringNo
overriden_scopes.messaging_channel_writestringNo
overriden_scopes.messaging_event_readstringNo
overriden_scopes.messaging_event_writestringNo
overriden_scopes.kms_space_readstringNo
overriden_scopes.kms_space_writestringNo
overriden_scopes.kms_page_readstringNo
overriden_scopes.kms_page_writestringNo
overriden_scopes.kms_comment_readstringNo
overriden_scopes.kms_comment_writestringNo
overriden_scopes.task_project_readstringNo
overriden_scopes.task_project_writestringNo
overriden_scopes.task_task_readstringNo
overriden_scopes.task_task_writestringNo
overriden_scopes.task_change_readstringNo
overriden_scopes.task_comment_readstringNo
overriden_scopes.task_comment_writestringNo
overriden_scopes.scim_users_readstringNo
overriden_scopes.scim_users_writestringNo
overriden_scopes.scim_groups_readstringNo
overriden_scopes.scim_groups_writestringNo
overriden_scopes.lms_course_readstringNo
overriden_scopes.lms_course_writestringNo
overriden_scopes.lms_class_readstringNo
overriden_scopes.lms_class_writestringNo
overriden_scopes.lms_student_readstringNo
overriden_scopes.lms_student_writestringNo
overriden_scopes.lms_instructor_readstringNo
overriden_scopes.lms_instructor_writestringNo
overriden_scopes.lms_content_readstringNo
overriden_scopes.lms_content_writestringNo
overriden_scopes.lms_collection_readstringNo
overriden_scopes.lms_collection_writestringNo
overriden_scopes.lms_activity_readstringNo
overriden_scopes.lms_activity_writestringNo
overriden_scopes.repo_organization_readstringNo
overriden_scopes.repo_organization_writestringNo
overriden_scopes.repo_repository_readstringNo
overriden_scopes.repo_repository_writestringNo
overriden_scopes.repo_branch_readstringNo
overriden_scopes.repo_branch_writestringNo
overriden_scopes.repo_commit_readstringNo
overriden_scopes.repo_commit_writestringNo
overriden_scopes.repo_pullrequest_readstringNo
overriden_scopes.repo_pullrequest_writestringNo
overriden_scopes.metadata_metadata_readstringNo
overriden_scopes.metadata_metadata_writestringNo
overriden_scopes.calendar_calendar_readstringNo
overriden_scopes.calendar_calendar_writestringNo
overriden_scopes.calendar_event_readstringNo
overriden_scopes.calendar_event_writestringNo
overriden_scopes.calendar_busy_readstringNo
overriden_scopes.calendar_link_readstringNo
overriden_scopes.calendar_link_writestringNo
overriden_scopes.calendar_recording_readstringNo
overriden_scopes.calendar_recording_writestringNo
overriden_scopes.calendar_webinar_readstringNo
overriden_scopes.calendar_webinar_writestringNo
overriden_scopes.calendar_bot_readstringNo
overriden_scopes.calendar_bot_writestringNo
overriden_scopes.calendar_botevent_readstringNo
overriden_scopes.calendar_room_readstringNo
overriden_scopes.calendar_location_readstringNo
overriden_scopes.enrich_person_readstringNo
overriden_scopes.enrich_company_readstringNo
overriden_scopes.ads_ad_readstringNo
overriden_scopes.ads_ad_writestringNo
overriden_scopes.ads_campaign_readstringNo
overriden_scopes.ads_campaign_writestringNo
overriden_scopes.ads_group_readstringNo
overriden_scopes.ads_group_writestringNo
overriden_scopes.ads_report_readstringNo
overriden_scopes.ads_organization_readstringNo
overriden_scopes.ads_organization_writestringNo
overriden_scopes.ads_creative_readstringNo
overriden_scopes.ads_creative_writestringNo
overriden_scopes.ads_asset_readstringNo
overriden_scopes.ads_asset_writestringNo
overriden_scopes.ads_insertionorder_readstringNo
overriden_scopes.ads_insertionorder_writestringNo
overriden_scopes.ads_target_readstringNo
overriden_scopes.ads_promoted_readstringNo
overriden_scopes.analytics_property_readstringNo
overriden_scopes.analytics_property_writestringNo
overriden_scopes.analytics_event_readstringNo
overriden_scopes.analytics_event_writestringNo
overriden_scopes.analytics_session_readstringNo
overriden_scopes.analytics_visitor_readstringNo
overriden_scopes.analytics_visitor_writestringNo
overriden_scopes.analytics_report_readstringNo
overriden_scopes.forms_form_readstringNo
overriden_scopes.forms_form_writestringNo
overriden_scopes.forms_submission_readstringNo
overriden_scopes.forms_submission_writestringNo
overriden_scopes.shipping_shipment_readstringNo
overriden_scopes.shipping_shipment_writestringNo
overriden_scopes.shipping_label_readstringNo
overriden_scopes.shipping_label_writestringNo
overriden_scopes.shipping_tracking_readstringNo
overriden_scopes.shipping_rate_readstringNo
overriden_scopes.shipping_rate_writestringNo
overriden_scopes.shipping_carrier_readstringNo
overriden_scopes.signing_document_readstringNo
overriden_scopes.signing_document_writestringNo
overriden_scopes.signing_signatory_readstringNo
overriden_scopes.signing_signatory_writestringNo
overriden_scopes.signing_template_readstringNo
overriden_scopes.signing_template_writestringNo
overriden_scopes.clubs_group_readstringNo
overriden_scopes.clubs_group_writestringNo
overriden_scopes.clubs_member_readstringNo
overriden_scopes.clubs_member_writestringNo
overriden_scopes.clubs_activity_readstringNo
overriden_scopes.clubs_activity_writestringNo
overriden_scopes.clubs_location_readstringNo
overriden_scopes.clubs_location_writestringNo
overriden_scopes.clubs_event_readstringNo
overriden_scopes.clubs_event_writestringNo
overriden_scopes.datastore_database_readstringNo
overriden_scopes.datastore_database_writestringNo
overriden_scopes.datastore_table_readstringNo
overriden_scopes.datastore_table_writestringNo
overriden_scopes.datastore_record_readstringNo
overriden_scopes.datastore_record_writestringNo
overriden_scopes.datastore_query_readstringNo
overriden_scopes.datastore_query_writestringNo
overriden_scopes.cdp_profile_readstringNo
overriden_scopes.cdp_profile_writestringNo
overriden_scopes.cdp_segment_readstringNo
overriden_scopes.cdp_segment_writestringNo
overriden_scopes.cdp_event_readstringNo
overriden_scopes.cdp_event_writestringNo
overriden_scopes.cdp_source_readstringNo
overriden_scopes.cdp_source_writestringNo
overriden_scopes.cdp_destination_readstringNo
overriden_scopes.cdp_destination_writestringNo
overriden_scopes.cdp_activation_readstringNo
overriden_scopes.cdp_activation_writestringNo
overriden_scopes.performance_cycle_readstringNo
overriden_scopes.performance_review_readstringNo
overriden_scopes.performance_review_writestringNo
overriden_scopes.performance_goal_readstringNo
overriden_scopes.performance_goal_writestringNo
overriden_scopes.performance_feedback_readstringNo
overriden_scopes.performance_feedback_writestringNo
overriden_scopes.social_post_readstringNo
overriden_scopes.social_post_writestringNo
overriden_scopes.social_profile_readstringNo
overriden_scopes.social_profile_writestringNo
overriden_scopes.social_review_readstringNo
overriden_scopes.social_review_writestringNo
overriden_scopes.social_insight_readstringNo
overriden_scopes.social_insight_writestringNo
overriden_scopes.legal_matter_readstringNo
overriden_scopes.legal_matter_writestringNo
overriden_scopes.legal_practicearea_readstringNo
overriden_scopes.legal_practicearea_writestringNo
overriden_scopes.legal_timeentry_readstringNo
overriden_scopes.legal_timeentry_writestringNo
overriden_scopes.legal_expense_readstringNo
overriden_scopes.legal_expense_writestringNo
overriden_scopes.compute_instance_readstringNo
overriden_scopes.compute_instance_writestringNo
overriden_scopes.compute_template_readstringNo
overriden_scopes.compute_template_writestringNo
overriden_scopes.compute_gputype_readstringNo
overriden_scopes.compute_region_readstringNo
overriden_scopes.compute_volume_readstringNo
overriden_scopes.compute_volume_writestringNo
overriden_scopes.compute_snapshot_readstringNo
overriden_scopes.compute_snapshot_writestringNo
overriden_scopes.compute_usage_readstringNo
overriden_scopes.compute_key_readstringNo
overriden_scopes.compute_key_writestringNo
overriden_scopes.compute_service_readstringNo
overriden_scopes.compute_service_writestringNo
overriden_scopes.compute_deployment_readstringNo
overriden_scopes.compute_deployment_writestringNo
overriden_scopes.compute_domain_readstringNo
overriden_scopes.compute_domain_writestringNo
overriden_scopes.compute_envvar_readstringNo
overriden_scopes.compute_envvar_writestringNo
overriden_scopes.healthcare_patient_readstringNo
overriden_scopes.healthcare_patient_writestringNo
overriden_scopes.healthcare_practitioner_readstringNo
overriden_scopes.healthcare_practitioner_writestringNo
overriden_scopes.healthcare_location_readstringNo
overriden_scopes.healthcare_location_writestringNo
overriden_scopes.healthcare_appointment_readstringNo
overriden_scopes.healthcare_appointment_writestringNo
overriden_scopes.healthcare_slot_readstringNo
overriden_scopes.healthcare_slot_writestringNo
overriden_scopes.healthcare_encounter_readstringNo
overriden_scopes.healthcare_encounter_writestringNo
overriden_scopes.healthcare_condition_readstringNo
overriden_scopes.healthcare_condition_writestringNo
overriden_scopes.healthcare_allergy_readstringNo
overriden_scopes.healthcare_allergy_writestringNo
overriden_scopes.healthcare_medication_readstringNo
overriden_scopes.healthcare_medication_writestringNo
overriden_scopes.healthcare_observation_readstringNo
overriden_scopes.healthcare_observation_writestringNo
overriden_scopes.healthcare_immunization_readstringNo
overriden_scopes.healthcare_immunization_writestringNo
overriden_scopes.healthcare_document_readstringNo
overriden_scopes.healthcare_document_writestringNo
overriden_scopes.healthcare_coverage_readstringNo
overriden_scopes.healthcare_coverage_writestringNo
overriden_scopes.healthcare_procedure_readstringNo
overriden_scopes.healthcare_procedure_writestringNo
overriden_scopes.healthcare_report_readstringNo
overriden_scopes.healthcare_report_writestringNo
overriden_scopes.healthcare_careplan_readstringNo
overriden_scopes.healthcare_careplan_writestringNo
overriden_scopes.healthcare_goal_readstringNo
overriden_scopes.healthcare_goal_writestringNo
overriden_scopes.property_listing_readstringNo
overriden_scopes.property_listing_writestringNo
overriden_scopes.property_unittype_readstringNo
overriden_scopes.property_guest_readstringNo
overriden_scopes.property_guest_writestringNo
overriden_scopes.property_reservation_readstringNo
overriden_scopes.property_reservation_writestringNo
overriden_scopes.property_availability_readstringNo
overriden_scopes.property_quote_readstringNo
overriden_scopes.property_quote_writestringNo
overriden_scopes.property_review_readstringNo
overriden_scopes.property_review_writestringNo
overriden_scopes.property_conversation_readstringNo
overriden_scopes.property_conversation_writestringNo
overriden_scopes.plm_part_readstringNo
overriden_scopes.plm_part_writestringNo
overriden_scopes.plm_bomline_readstringNo
overriden_scopes.plm_bomline_writestringNo
overriden_scopes.plm_document_readstringNo
overriden_scopes.plm_document_writestringNo
overriden_scopes.plm_change_readstringNo
overriden_scopes.plm_change_writestringNo
overriden_scopes.plm_category_readstringNo
overriden_scopes.plm_category_writestringNo
success_redirectstringNoPost-OAuth success URL for marketplace installs (e.g. HighLevel). Used by /oauth/code/{workspace}/{env}/{integration}.
failure_redirectstringNoPost-OAuth failure URL for marketplace installs. Used by /oauth/code/{workspace}/{env}/{integration}.
authobjectNo
auth.client_idstringNo
auth.client_secretstringNo
auth.consumer_keystringNo
auth.consumer_secretstringNo
auth.pemstringNothe PEM X.509 certificate in Base64 ASCII format
auth.keystringNothe private KEY X.509 certificate in Base64 ASCII format
auth.dev_api_keystringNo
auth.saml_idp_urlstringNothe SAML IdP SSO/login URL for end-user SAML login
auth.saml_idp_entity_idstringNothe SAML IdP issuer/entity ID
auth.saml_pemstringNothe SAML IdP signing certificate; PEM X.509 in Base64 ASCII format
auth.needs_pkcebooleanNoopt-in PKCE for OAuth2 when the integration app or org requires it
secretsmanager_idstringNothe ID of the SecretsManager object
secretsmanager_keystringNothe key/path/name of the secret within the vault

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/workspaceintegration',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?