v5
latestOpenAPI 3.0.02026-08-017841,2603.2 MBunified
webhook
Create webhook subscription
The data payload received by your server is described at https://docs.unified.to/unified/overview. The interval field can be set as low as 1 minute for paid accounts, and 60 minutes for free accounts.
post/unified/webhook
Query parameters
include_allboolean
When set, all of the existing data will sent back to your server.
Request body
idstring
created_atstring date-time
updated_atstring date-time
workspace_idstring
connection_idstring required
hook_urlstring
object_type'accounting_account' | 'accounting_transaction' | 'accounting_journal' | 'accounting_contact' | 'accounting_invoice' | 'accounting_bill' | 'accounting_vendorcredit' | 'accounting_creditmemo' | 'accounting_taxrate' | 'accounting_organization' | 'accounting_order' | 'accounting_salesorder' | 'accounting_purchaseorder' | 'accounting_report' | 'accounting_balancesheet' | 'accounting_profitloss' | 'accounting_trialbalance' | 'accounting_category' | 'accounting_expense' | 'accounting_cashflow' | 'payment_payment' | 'payment_link' | 'payment_payout' | 'payment_refund' | 'payment_subscription' | 'commerce_item' | 'commerce_collection' | 'commerce_inventory' | 'commerce_location' | 'commerce_review' | 'commerce_saleschannel' | 'commerce_itemvariant' | 'commerce_reservation' | 'commerce_availability' | 'verification_package' | 'verification_request' | 'assessment_package' | 'assessment_order' | 'ats_activity' | 'ats_application' | 'ats_applicationstatus' | 'ats_candidate' | 'ats_document' | 'ats_interview' | 'ats_job' | 'ats_scorecard' | 'ats_company' | 'crm_company' | 'crm_contact' | 'crm_deal' | 'crm_event' | 'crm_lead' | 'crm_pipeline' | 'crm_picklist' | 'hris_employee' | 'hris_group' | 'hris_payslip' | 'hris_timeoff' | 'hris_company' | 'hris_location' | 'hris_device' | 'hris_timeshift' | 'hris_deduction' | 'hris_benefit' | 'hris_bankaccount' | 'hris_document' | 'hris_taxonomy' | 'martech_list' | 'martech_member' | 'martech_campaign' | 'martech_report' | 'passthrough' | 'ticketing_note' | 'ticketing_ticket' | 'ticketing_customer' | 'ticketing_category' | 'uc_contact' | 'uc_call' | 'uc_comment' | 'uc_recording' | 'enrich_person' | 'enrich_company' | 'storage_file' | 'genai_model' | 'genai_prompt' | 'genai_embedding' | 'messaging_message' | 'messaging_channel' | 'messaging_event' | 'kms_space' | 'kms_page' | 'kms_comment' | 'task_project' | 'task_task' | 'task_comment' | 'task_change' | 'scim_users' | 'scim_groups' | 'lms_course' | 'lms_class' | 'lms_student' | 'lms_instructor' | 'lms_content' | 'lms_collection' | 'lms_activity' | 'repo_organization' | 'repo_repository' | 'repo_branch' | 'repo_commit' | 'repo_pullrequest' | 'metadata_metadata' | 'calendar_calendar' | 'calendar_event' | 'calendar_busy' | 'calendar_link' | 'calendar_recording' | 'calendar_webinar' | 'ads_organization' | 'ads_ad' | 'ads_campaign' | 'ads_report' | 'ads_group' | 'ads_creative' | 'ads_asset' | 'ads_insertionorder' | 'ads_target' | 'ads_promoted' | 'analytics_property' | 'analytics_event' | 'analytics_session' | 'analytics_visitor' | 'analytics_report' | 'forms_form' | 'forms_submission' | 'shipping_carrier' | 'shipping_rate' | 'shipping_shipment' | 'shipping_label' | 'shipping_tracking' | 'signing_document' | 'signing_signatory' | 'signing_template' | 'clubs_group' | 'clubs_member' | 'clubs_activity' | 'clubs_location' | 'clubs_event' | 'datastore_database' | 'datastore_table' | 'datastore_record' | 'datastore_query' | 'cdp_profile' | 'cdp_segment' | 'cdp_event' | 'cdp_source' | 'cdp_destination' | 'cdp_activation' required
intervalnumber
checked_atstring date-time
integration_typestring
environmentstring
event'updated' | 'created' | 'deleted' required
runsstring[]
An array of the most revent virtual webhook runs
fieldsstring
webhook_type'virtual' | 'native'
is_healthyboolean
page_max_limitnumber
filtersPropertyWebhookFilters
db_type'mongodb' | 'mysql' | 'postgres' | 'mssql' | 'mariadb' | 'supabase' | 'snowflake'
db_urlstring
db_schemastring
db_name_prefixstring
is_pausedboolean
is_betaboolean
Response
Successful
idstring
created_atstring date-time
updated_atstring date-time
workspace_idstring
connection_idstring required
hook_urlstring
object_type'accounting_account' | 'accounting_transaction' | 'accounting_journal' | 'accounting_contact' | 'accounting_invoice' | 'accounting_bill' | 'accounting_vendorcredit' | 'accounting_creditmemo' | 'accounting_taxrate' | 'accounting_organization' | 'accounting_order' | 'accounting_salesorder' | 'accounting_purchaseorder' | 'accounting_report' | 'accounting_balancesheet' | 'accounting_profitloss' | 'accounting_trialbalance' | 'accounting_category' | 'accounting_expense' | 'accounting_cashflow' | 'payment_payment' | 'payment_link' | 'payment_payout' | 'payment_refund' | 'payment_subscription' | 'commerce_item' | 'commerce_collection' | 'commerce_inventory' | 'commerce_location' | 'commerce_review' | 'commerce_saleschannel' | 'commerce_itemvariant' | 'commerce_reservation' | 'commerce_availability' | 'verification_package' | 'verification_request' | 'assessment_package' | 'assessment_order' | 'ats_activity' | 'ats_application' | 'ats_applicationstatus' | 'ats_candidate' | 'ats_document' | 'ats_interview' | 'ats_job' | 'ats_scorecard' | 'ats_company' | 'crm_company' | 'crm_contact' | 'crm_deal' | 'crm_event' | 'crm_lead' | 'crm_pipeline' | 'crm_picklist' | 'hris_employee' | 'hris_group' | 'hris_payslip' | 'hris_timeoff' | 'hris_company' | 'hris_location' | 'hris_device' | 'hris_timeshift' | 'hris_deduction' | 'hris_benefit' | 'hris_bankaccount' | 'hris_document' | 'hris_taxonomy' | 'martech_list' | 'martech_member' | 'martech_campaign' | 'martech_report' | 'passthrough' | 'ticketing_note' | 'ticketing_ticket' | 'ticketing_customer' | 'ticketing_category' | 'uc_contact' | 'uc_call' | 'uc_comment' | 'uc_recording' | 'enrich_person' | 'enrich_company' | 'storage_file' | 'genai_model' | 'genai_prompt' | 'genai_embedding' | 'messaging_message' | 'messaging_channel' | 'messaging_event' | 'kms_space' | 'kms_page' | 'kms_comment' | 'task_project' | 'task_task' | 'task_comment' | 'task_change' | 'scim_users' | 'scim_groups' | 'lms_course' | 'lms_class' | 'lms_student' | 'lms_instructor' | 'lms_content' | 'lms_collection' | 'lms_activity' | 'repo_organization' | 'repo_repository' | 'repo_branch' | 'repo_commit' | 'repo_pullrequest' | 'metadata_metadata' | 'calendar_calendar' | 'calendar_event' | 'calendar_busy' | 'calendar_link' | 'calendar_recording' | 'calendar_webinar' | 'ads_organization' | 'ads_ad' | 'ads_campaign' | 'ads_report' | 'ads_group' | 'ads_creative' | 'ads_asset' | 'ads_insertionorder' | 'ads_target' | 'ads_promoted' | 'analytics_property' | 'analytics_event' | 'analytics_session' | 'analytics_visitor' | 'analytics_report' | 'forms_form' | 'forms_submission' | 'shipping_carrier' | 'shipping_rate' | 'shipping_shipment' | 'shipping_label' | 'shipping_tracking' | 'signing_document' | 'signing_signatory' | 'signing_template' | 'clubs_group' | 'clubs_member' | 'clubs_activity' | 'clubs_location' | 'clubs_event' | 'datastore_database' | 'datastore_table' | 'datastore_record' | 'datastore_query' | 'cdp_profile' | 'cdp_segment' | 'cdp_event' | 'cdp_source' | 'cdp_destination' | 'cdp_activation' required
intervalnumber
checked_atstring date-time
integration_typestring
environmentstring
event'updated' | 'created' | 'deleted' required
runsstring[]
An array of the most revent virtual webhook runs
fieldsstring
webhook_type'virtual' | 'native'
is_healthyboolean
page_max_limitnumber
filtersPropertyWebhookFilters
db_type'mongodb' | 'mysql' | 'postgres' | 'mssql' | 'mariadb' | 'supabase' | 'snowflake'
db_urlstring
db_schemastring
db_name_prefixstring
is_pausedboolean
is_betaboolean